Common Tasks

Here is the list of the most commonly used Cygna Auditor API endpoints.

ENDPOINT

METHOD

DESCRIPTION

Events

/api/v{version}/events/{id}

GET

Queries an audit event

/api/v{version}/events

POST

Retrieves audit events (with prefiltering)

Identity

/api/v{version}/identity/all

DELETE

Revokes Cygna identity settings

/api/v{version}/identity

 

GET

Retrieves Cygna identities

POST

Creates a new Cygna identity

/api/v{version}/identity/{id}

 

 

GET

Queries Cygna identity details

DELETE

Removes a Cygna identity

PUT

Updates a Cygna identity

/api/v{version}/identity/{identity}/accounts/{id}

DELETE

Disassociate a user with Cygna identity

Delegation (users, roles, and permissions)

/api/v{version}/delegation/permissions

GET

Retrieves permissions

/api/v{version}/delegation/roles

 

 

GET

Retrieves roles

POST

Creates a role

PUT

Updates a role

/api/v{version}/delegation/roles/{id}

 

GET

Queries role details

DELETE

Removes a role

/api/v{version}/delegation/roles/accounts

GET

Retrieves accounts

/api/v{version}/delegation/roles/{id}/accounts

 

GET

Retrieves accounts for a specific role

POST

Assigns a specific role to a user

/api/v{version}/delegation/roles/{id}/accounts/{accountId}

 

GET

Queries a specific account details

PUT

Updates a user account

/api/v{version}/delegation/roles/{roleId}/accounts/{accountId}

DELETE

Revokes a role assignment

/api/v{version}/delegation/users

GET

Retrieves users with roles

POST

Creates a new user

/api/v{version}/delegation/users/{id}

 

DELETE

Removes a user

PUT

Updates a user

/api/v{version}/delegation/users/{id}/permissions

GET

Retrieves permissions for a specific user

/api/v{version}/delegation/users/{id}/roles

GET

Retrieves roles for a specific user

Note: If you are looking for endpoint descriptions or a complete object reference, go to API Reference.