Managed Account
Manage accounts that the product controls.
Add one NPS user
Adds a host user as an NPS user. Identify the user by userId or by sid. If you supply a sid and omit name, the name defaults to the user's display name.
Add several users and groups to NPS
Adds a list of domain users and domain groups as NPS users and groups in one call, then synchronizes the members of any domain groups you added. A domain user whose NPS account was deleted earlier is reactivated. Use it to onboard many accounts at once.
Get an NPS user by sign-in account ID
Returns the NPS user linked to a Netwrix Privilege Secure sign-in account, including the user's name, account names, email address, last sign-in time, lock state and reviewer flag. Use it when you have the ID of the sign-in account rather than the NPS user ID. The policies, resources and activeSessions arrays in the response are always empty and scheduledSessionCount is 0; use the Policies call for the user's policies.
Get an NPS user by ID
Returns one NPS user, including the user's name, account names, email address, last sign-in time, lock state and reviewer flag. Administrators and users with the Auditing and Reporting role can read any NPS user. Other callers can read only their own record. The policies, resources and activeSessions arrays in the response are always empty and scheduledSessionCount is 0; use the Policies call for the user's policies.
Get an NPS user by sign-in identity ID
Returns the NPS user record linked to a Netwrix Privilege Secure sign-in account. Use it when you have the ID of a user's sign-in account and need the matching NPS user.
Get an NPS user by SID
Returns the NPS user whose Windows security identifier (SID) matches the value you supply. Use it to find an NPS user from an Active Directory SID.
Get an NPS user by host user ID
Returns the NPS user that is linked to a host user, including the user's name, account names, email address, last sign-in time, lock state and reviewer flag. Use it when you have a host user ID, for example from a resource scan, and need the NPS user. The policies, resources and activeSessions arrays in the response are always empty and scheduledSessionCount is 0; use the Policies call for the user's policies.
Create an application user
Creates an application user, which is an NPS user that signs in with an API key, and generates its API key. Retrieve the key afterward with the Reveal API Key call.
Create a local user
Creates a local user, which is an NPS user that signs in with a password stored in Netwrix Privilege Secure, and sets its first password.
Delete several NPS users and groups
Deletes a list of NPS users and groups in one call. Users are marked as deleted and lose their sign-in account and console access; groups are removed. Only entries with entityType 0 (user) or 1 (group) are processed, so use the application user and local user delete calls for those kinds.
Delete several application users
Deletes a list of application users and their API credentials in one call. The response reports how many were deleted and how many failed.
Delete several local users
Deletes a list of local users and their sign-in accounts in one call. The response reports how many were deleted and how many failed.
Generate a new API key for an application user
Creates a new API key for an application user and replaces the existing one. Use it to rotate the key. Retrieve the new key with the Reveal API Key call.
Search users and groups available to add to NPS
Searches the host users, domain groups, application users and domain group members that can be added as NPS users. Use it to find candidates before you add them with the Add Multiple call.
List application user names and IDs
Returns the name and NPS user ID of every application user. Use it to fill a picker or to find an application user's ID.
List local user names and IDs
Returns the name and NPS user ID of every local user, which are the users that sign in with a Netwrix Privilege Secure password. Use it to fill a picker or to find a local user's ID.
Get the list view of an NPS user
Returns one NPS user in the form used by the Users and Groups list, with counts of active sessions, scheduled sessions and access policies, last sign-in time, lock state and license count.
Reset a local user's password
Sets a new password for a local user without needing the current password. Use it when a local user is locked out or has forgotten the password.
Reset multifactor authentication for an NPS user
Turns off the user's multifactor authentication settings and clears the stored authentication tokens. Use it when a user loses the device they use for multifactor authentication.
Reveal an application user's API key
Returns the current API key of an application user as plain text. Use it when you need to configure an application with the key.
List reviewers
Returns every NPS user who is a reviewer, including users who are reviewers through a reviewer group, nested group or collection. Deleted users and users with no linked host user are left out. The list is sorted by account name.
Make several users and groups reviewers
Gives the reviewer role to a list of NPS users, groups and collections. The response is a text message with the number added.
Remove several users and groups from reviewers
Removes the reviewer role from a list of NPS users, groups and collections. The response is a text message with the number removed.
Search reviewers or reviewer candidates
Searches NPS users, groups and collections that are reviewers, or that could be made reviewers. Set candidates to true to list who can be added and to false to list who is a reviewer now.
Set or clear the reviewer role for an NPS user
Turns the reviewer role on or off for one NPS user and returns the updated user. If you omit isReviewer, the role is turned off.
Search NPS users and groups
Searches the NPS users and groups that appear in the Users and Groups list. You can filter by kind, text, domain and license state, and by the last sign-in time. The results are paged.
Update an application user
Updates the name and profile details of an application user and returns the updated user.
Update a local user
Updates a local user's name and profile details and returns the updated user. The name is also the user name the local user signs in with, so changing it changes the sign-in name.
Delete an NPS user
Removes an NPS user. The call deletes the user's stored credentials, marks the account as deleted, and removes the user's sign-in identity and console access if they have them. Use it when a person or account no longer needs to use Netwrix Privilege Secure.
List the groups an NPS user belongs to
Returns the NPS groups that the NPS user is a member of. Use it to see how a user inherits access through groups.
Lock an NPS user
Locks an NPS user and returns the updated user. The call also locks the user's active, pending and approval-required sessions, including live connections. Use it to stop a user from working until you unlock the account.
List the access policies of an NPS user
Returns the access policies that the NPS user is a member of, including the activities and resources each policy covers.
Unlock an NPS user
Unlocks an NPS user and returns the updated user. The call also unlocks the user's active, pending and approval-required sessions, and for host users it clears a sign-in lockout.