Credential
Manage stored credentials.
List credentials of one type
Returns the credentials of one type. Without a type it returns the Configuration credentials, which are the service accounts used by resources. The Search route is the better choice for most uses.
Create a credential
Creates a credential (service account) that NPS uses to sign in to resources. If the request carries the ID of an existing credential and a domain, that credential is updated instead and set to the Configuration type. If the domain and user name already belong to a different credential, the call returns 409.
Count credentials
Returns a single number: how many credentials and discovered users match, using the same set as the Search route (Application-type credentials are not counted). For users with the UserPlus role the count covers only the items that user can see.
Delete several credentials
Marks the credentials whose IDs you list as deleted and reports how many were deleted and how many failed. An ID that does not match a credential counts as a failure. Unlike the single delete route, it does not check whether a domain or resource still uses the credential. Use it to remove many credentials in one call.
List credential authentication methods
Returns the authentication methods a credential can use, as names with their numbers. Use it to look up the values for the authenticationMethod field.
Get the SSH key for a credential
Returns the SSH key settings for one SSH key credential, including the private key, public key and passphrase in plain text. Use it when you need to retrieve the key material.
List credential types
Returns the credential types as names with their numbers. Use it to look up the values for the type field and the type and credentialType query parameters.
Set when credential passwords rotate
Sets whether the passwords of the listed credentials change at the start of a session, at the end of a session, or both, and what happens to the account afterward. It applies only to credentials whose managed user rotates automatically. The credentials are updated in list order, so if one fails, the ones before it are already changed.
Search credentials and discovered users
Returns one page of credentials and discovered users, including users found by directory sync and host scans. You can filter by text, type, management state and privilege. Application-type credentials are never returned, and credentials held in a password vault are left out unless the deployment is set to release them. For users with only the UserPlus role, the results cover only what that user can see.
List supported SSH key algorithms
Returns the SSH key algorithms the product supports (RSA and ECDSA). Each algorithm lists the key lengths it allows: 1024, 2048 and 4096 for RSA, and 256, 384 and 521 for ECDSA. Use it to choose values for keyGenAlgorithm and keyLength.
Delete a credential
Deletes one credential (service account) by ID. The credential is marked deleted and removed from any access policies it belongs to. Use it to remove a credential that is no longer needed.
Get a credential by ID
Returns one credential, including whether it is managed. Password, key and passphrase values are blank unless you set showPassword to true. For Admin users, showPassword has no effect on Configuration (service account) credentials, and each password view by an Admin is recorded as an event.
Update a credential
Replaces the settings of one credential with the body you send. A blank password or enable password keeps the stored value, so you can update other fields without re-sending secrets.