Auth APIs

Auth APIs

/api/auth - APIs for performing authentication specific operations

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