Administration Audit Events

20 Dec 2023
1 Minute to read

Print
Dark
Light
PDF

Administration Audit Events

Updated on 20 Dec 2023
1 Minute to read

Print
Dark
Light
PDF

Article Summary

Share feedback

Thanks for sharing your feedback!

Get

/api/1.0/audit-admin/{envId}

The GET Admin Audit Events method retrieves administrative audit events within a specific Environment. Fetching Admin Audit Events is contextual to a specific Environment, allowing customers to audit their different Environments based on their unique governance and regulatory requirements. Access to this API requires an Environment Admin Role.

Notice

Accessing the Policy Management APIs is through a dedicated domain/URL according to your PlainID Tenant Location:
https://api.{REGION}.plainid.io

United States (US) - https://api.us1.plainid.io
Canada (US) - https://api.ca1.plainid.io
Europe (US) - https://api.eu1.plainid.io

Replace{REGION} with your PlainID Tenant region (e.g. us1, eu1, ca1, etc.).

Security

Http

Type bearer

For more details about Management API Authentication, check out the Management APIs Authentication Article
Provide your bearer token in the Authorization header when making requests to protected resources.
Example: `Authorization: Bearer 123`

Path parameters

envId

string (uuid) Required

The Environment ID can be found under the Details tab in the Environment Settings.

Query parameters

limit

integer

Maximum1000

Minimum1

Default"50"

offset

integer

Minimum0

Default"0"

filter[timestamp][gt]

integer

Timestamp is in milliseconds

filter[timestamp][gte]

integer

filter[timestamp][lt]

integer

filter[timestamp][lte]

integer

filter[action][eq]

string

filter[action][ne]

string

filter[action][like]

string

filter[action][ilike]

string

filter[action][not-like]

string

filter[resourceType][eq]

string

filter[resourceType][ne]

string

filter[resourceType][like]

string

filter[resourceType][ilike]

string

filter[resourceType][not-like]

string

filter[resourceId][eq]

string

ID of a specific object

filter[resourceId][ne]

string

filter[parentObjectType][eq]

string

filter[parentObjectType][ne]

string

filter[parentObjectType][like]

string

filter[parentObjectType][ilike]

string

filter[parentObjectType][not-like]

string

filter[parentObjectName][eq]

string

filter[parentObjectName][ne]

string

filter[parentObjectName][like]

string

filter[parentObjectName][ilike]

string

filter[parentObjectName][not-like]

string

filter[parentObjectId][eq]

string

filter[parentObjectId][ne]

string

filter[userId][eq]

string

userId is the IDP userId used to log in to the tenant

filter[userId][ne]

string

sort[action]

string

Valid values[ "\"ASC\"", "\"DESC\"" ]

sort[timestamp]

string

Valid values[ "\"ASC\"", "\"DESC\"" ]

Responses

200

List of administration audit events log

Expand All

object

data

Array of object (auditAdminLog)

object

string

action

string

Max length100

timestamp

integer

userId

string

resourceType

string

resourceId

string (uuid)

resourceName

string

parentObjectType

string

parentObjectId

string (uuid)

parentObjectName

string

oldValue

object

newValue

object

additionalData

object

total

integer

Total number of items

Minimum0

limit

integer

Maximum50

Minimum0

offset

integer

Minimum0

Default"0"

400

Bad request

Expand All

object

code

string

status

integer

name

string

message

string

args

object

path

string

403

Operation GET for resource AuditLog is not permitted due to the current user's lack of permissions.

Expand All

object

code

string

status

integer

name

string

message

string

args

object

path

string

Was this article helpful?

What's Next

Create API Client Credentials