Auth APIs

Auth APIs

/api/auth - APIs for performing authentication specific operations

Operations

Acquire Token Using POST

Acquire a token to perform REST API calls

Add Auth Source Using POST

Add a new authentication source in the system

Add Role Privileges Using POST

Add the privileges to a user role

Assign Role Permission To User Group Using PUT

Assign a role permission to a particular user group

Assign Role Permission To User Using PUT

Assign a role permission to a particular user

Assign Traversal Spec To User Group Using PUT Deprecated

(Deprecated) Assign a traversal specification to a particular user

Assign Traversal Spec To User Using PUT Deprecated

(Deprecated) Assign a traversal specification to a particular user.

Change Password Using PUT

Change the password of the active user

Create User Group Using POST

Create a new local user group or import SSO/VIDM/LDAP/AD user groups

Create User Role Using POST

Create a user role

Create User Using POST

Create a new user

Delete Auth Source Using DELETE

Delete an authentication source

Delete User Groups Using DELETE

Delete a list of user groups using their identifiers

Delete User Group Using DELETE

Delete a local user group

Delete User Role Using DELETE

Remove role with given role name

Delete Users Using DELETE

Delete a collection of users with the given identifiers

Delete User Using DELETE

Get Assigned Role Permissions For Current User Using GET

Get assigned role permissions for an initiator of this API method

Get Assigned Role Permissions For User Group Using GET

Get assigned role permissions for the user group

Get Assigned Role Permissions For User Using GET

Get assigned role permissions for a user

Get Auth Sources Using GET

Get all the available authentication sources in the system

Get Auth Source Types Using GET

Get all the available authentication source types

Get Auth Source Type Using GET

Retrieve information about a particular authentication source type

Get Auth Source Using GET

Retrieve detailed information about a particular authentication source

Get Available Privilege Groups Using GET

Get the available privilege groups

Get Available Privileges Using GET

Get the available privileges

Get Current User Role Privileges Using GET

Get privileges of a role for an initiator of this API method

Get Current User Using GET

Look up for an initiator of this API method

Get Role By Name Using GET

Look up a role with the given name

Get Role Privileges Using GET

Get the privileges for a user role

Get Roles Using GET

Find list of application roles using the role names

Get Traversal Specs Using GET

Get/Query the list of all traversal specification templates in the system

Get User Groups Using GET

Retrieve a list of local user groups using identifiers or/and names

Get User Group Using GET

Look up a local user group using its identifier

Get Users Using GET

Look up a list of users using the user identifiers or their role names

Get User Using GET

Look up a particular user using its identifier

Import Users Using POST

Import users from the auth source

Modify User Group Using PUT

Modify a local user group

Modify User Using PUT

Modify the details of a particular user

Patch Auth Source With Certificate Details Using PATCH

Patch an already added authentication source with the certificate data

Patch Test Auth Source Using PATCH

Patch an already tested authentication source with the certificate data

Release Token Using POST

Terminate the current sessionId

Remove Role Privileges Using DELETE

Remove specified privileges from the user role

Search User Groups For Auth Source Using POST

Search user-groups for an auth source

Search Users For Auth Source Using POST

Search users for an auth source

Set Role Privileges Using PUT

Set the privileges for a user role

Synchronize User Groups Using PUT

Synchronize user groups

Test Auth Source Using POST

Test a new or an existing authentication source in the system

Unassigned Role Permission From User Group Using DELETE

Unassign role permission from a user group

Unassigned Role Permission From User Using DELETE

Unassign role permission from a user

Update Auth Source Using PUT

Update an authentication source in the system

Update User Role Using PUT

Update a user role