Auth APIs
/api/auth - APIs for performing authentication specific operations
Operations
GET
Get Users
Look up a list of users using the user identifiers or their role names
PUT
Modify User
Modify the details of a particular user
POST
Create User
Create a new user
DELETE
Delete Users
Delete a collection of users with the given identifiers
PUT
Assign Traversal Spec To User Deprecated
(Deprecated) Assign a traversal specification to a particular user.
GET
Get Assigned Role Permissions For User
Get assigned role permissions for a user
PUT
Assign Role Permission To User
Assign a role permission to a particular user
PUT
Change Password
Change the password of the active user
GET
Get User Groups
Retrieve a list of local user groups using identifiers or/and names
PUT
Modify User Group
Modify a local user group
POST
Create User Group
Create a new local user group or import SSO/VIDM/LDAP/AD/VIDB user groups
DELETE
Delete User Groups
Delete a list of user groups using their identifiers
PUT
Assign Traversal Spec To User Group Deprecated
(Deprecated) Assign a traversal specification to a particular user
GET
Get Assigned Role Permissions For User Group
Get assigned role permissions for the user group
PUT
Assign Role Permission To User Group
Assign a role permission to a particular user group
GET
Get Auth Sources
Get all the available authentication sources in the system
PUT
Update Auth Source
Update an authentication source in the system
POST
Add Auth Source
Add a new authentication source in the system
PATCH
Patch Auth Source With Certificate Details
Patch an already added authentication source with the certificate data
PUT
Synchronize User Groups
Synchronize user groups
GET
Get All Object Scopes
Get all scopes
PUT
Modify Scope
Modify a Scope
POST
Create Scope
Create a new Scope
DELETE
Delete Scopes
Delete scopes
GET
Get Roles
Find list of application roles using the role names
PUT
Update User Role
Update a user role
POST
Create User Role
Create a user role
GET
Get Role Privileges
Get the privileges for a user role
PUT
Set Role Privileges
Set the privileges for a user role
POST
Add Role Privileges
Add the privileges to a user role
DELETE
Remove Role Privileges
Remove specified privileges from the user role
POST
Release Token
Terminate the current sessionId
POST
Acquire Token
Acquire a token to perform REST API calls
POST
Import Users
Import users from the auth source
POST
Search Users For Auth Source
Search users for an auth source
POST
Search User Groups For Auth Source
Search user-groups for an auth source
POST
Test Auth Source
Test a new or an existing authentication source in the system
PATCH
Patch Test Auth Source
Patch an already tested authentication source with the certificate data
GET
Get User
Look up a particular user using its identifier
DELETE
Delete User
Delete a user
GET
Get User Group
Look up a local user group using its identifier
DELETE
Delete User Group
Delete a local user group
GET
Get Traversal Specs
Get/Query the list of all traversal specification templates in the system
GET
Get Auth Source Types
Get all the available authentication source types
GET
Get Auth Source Type
Retrieve information about a particular authentication source type
GET
Get Auth Source
Retrieve detailed information about a particular authentication source
DELETE
Delete Auth Source
Delete an authentication source
GET
Get Scope
Get the scope
GET
Get Role By Name
Look up a role with the given name
DELETE
Delete User Role
Remove role with given role name
GET
Get Available Privileges
Get the available privileges
GET
Get Available Privilege Groups
Get the available privilege groups
GET
Get Current User
Look up for an initiator of this API method
GET
Get Current User Role Privileges
Get privileges of a role for an initiator of this API method
GET
Get Assigned Role Permissions For Current User
Get assigned role permissions for an initiator of this API method
DELETE
Unassigned Role Permission From User
Unassign role permission from a user
DELETE
Unassigned Role Permission From User Group
Unassign role permission from a user group