Managed Resource
Manage resources that the product controls.
Create a resource
Creates a resource record and returns it. Use it to create the record for a host or an Active Directory domain when you already have its details. Only one resource of a given type can exist for a host or a domain configuration.
Get the resource for an Active Directory domain
Returns the resource that represents one Active Directory domain configuration. Use it to look up a domain resource when you know the domain configuration ID.
Get the resource for a host
Returns the resource that is built on one host. Use it to find out whether a discovered host is already managed.
Bring hosts under management
Turns discovered domain hosts into managed resources that use the service account you name, and starts a host scan for each of them. A host that is already a resource is switched to the service account instead. Use the IDs from the candidate search for the host list.
Search hosts that are not yet managed
Returns a page of discovered hosts and resources that you can bring under management. Use it to find the host IDs to pass to the add-multiple call.
Remove several resources
Removes the resources whose IDs you send, along with the managed accounts, local accounts and their stored credentials, protected group members, scheduled jobs and group links that belong to them. Set removeFromDb to also delete the host records.
List Active Directory domain resources
Returns the name and ID of each resource that is an Active Directory domain. Use the ID to read the full resource with the get-resource call.
List the resources in a resource group
Returns a page of the resources that belong to one resource group, with their operating system, platform, service account and last scan time. Set showAll to also list hosts from a mapped organizational unit that are not yet onboarded.
Set account management for every resource in a group
Turns management of the built-in administrator account on or off for every resource in one resource group.
Set account management for chosen resources in a group
Turns management of the built-in administrator account on or off for the resources you list in one resource group.
List operating systems across resources
Returns each distinct operating system value found on your resources, sorted. Resources with no operating system add the labels Website, Secret Vault or Unknown. Use the values to fill an operating system filter.
Set the platform of several resources
Sets the platform of each resource you list. The new platform is also applied to the resource's scheduled jobs and to the credentials it uses.
Scan resources to detect their platform
Schedules one host scan that detects and saves the platform and operating system of the resources you send, without a full account and group scan. Resources that already have a platform, or that have no host or credential, are skipped.
Create a protected group
Creates a protected group for a resource and returns it. Once protection policy schedules run for the resource, users who are not listed as members are removed from the group.
Add a member to a protected group
Adds a member to a protected group and returns it. A member belongs to the allowed list, the current list, or both.
Add or update a protected group member
Saves a protected group member. If a member with the same ID exists it is updated, otherwise a new member is created.
Remove a member from a protected group
Removes one member record from a protected group. Use it to take a user off the allowed or current member list of a protected group.
Get a protected group member
Returns one member record of a protected group. The response is empty when no member has this ID.
Remove a protected group
Removes one protected group from a resource. Use it when the group no longer needs to be tracked.
Get a protected group
Returns one protected group of a resource, including its allowed and current members. The response is empty when no group has this ID.
List the allowed members of a protected group
Returns the members that are allowed to belong to one protected group.
List the current members of a protected group
Returns the members that currently belong to one protected group.
Get several resources by ID
Returns the resources whose IDs you send, with no filtering or paging.
Search resources
Returns a page of resources that you can filter by type, domain, operating system, resource group and last scan date. This is the recommended way to list resources.
Set the service account of several resources
Sets the service account that each listed resource uses to connect.
Start a connection test for a resource
Starts a test of the connection to a resource using its service account and returns the ID of the test. Read the result with the connection test status call.
Get the result of a connection test
Returns the status of a connection test that you started for a resource, with the result of each step. Poll it after you start a test until the status is Passed or Failed.
List resources whose platform is not detected
Returns the IDs of scannable resources whose platform has not been determined yet, on either the resource or its host and that have a usable credential. Resources that cannot be host-scanned, such as Microsoft Entra ID, SQL or Oracle resources, are left out. Pass the IDs to the platform detection scan call.
Search the accounts on resources
Returns a page of the local and domain accounts found on resources, with their management state, password schedule and last password check. Use hostId or domainConfigId to limit the accounts to one host or one domain.
Configure WinRM over HTTPS on a Windows host
Starts a job that sets up WinRM over HTTPS on a Windows host resource and switches the resource to use HTTPS for WinRM. The call returns the ID of the queued job. Use the job ID to follow its progress.
Test WinRM over HTTPS on a host
Connects to the host on its configured WinRM over HTTPS port without sending credentials and returns the thumbprint of the certificate the host presents, as a JSON string. Use it to check the connection before you trust or configure a certificate.
Remove a resource
Removes one resource from management, along with the managed accounts, local accounts and their stored credentials, protected group members, scheduled jobs and group links that belong to it. The record of a host that came from an Active Directory domain is kept.
Get a resource
Returns one resource. Administrators and application accounts can read any resource. Other users can read only the resources assigned to access policies they are assigned to.
Update a resource
Replaces the settings of one resource, such as its platform, service account, ports and certificate trust options. The host record is updated to match the service account and platform.
Get the built-in administrator account of a resource
Returns the built-in administrator account of a resource, as an account record, when the resource's platform defines one. The response is empty when the platform has no built-in administrator account.
List the resource groups of a resource
Returns the resource groups that one resource belongs to.
List the protected groups of a resource
Returns the protected groups that belong to one resource. System groups are left out unless you ask for them.
Trust the discovered certificate of a resource
Saves the certificate thumbprint that Privilege Secure last discovered on a resource as the trusted thumbprint for the certificate type you name.