Administration Audit Events

Prev Next
Get
/api/1.0/audit-admin/{envId}

The GET Admin Audit Events method retrieves administrative audit events within a specific Environment or Tenant.
For more information, refer to our documentation on Administration Audit Reports.

Notice

Accessing the Policy Management API is through a dedicated domain/URL, according to your PlainID Tenant Location
  • United States (US) - https://api.us1.plainid.io
  • Canada (CA) - https://api.ca1.plainid.io
  • Europe (EU) - https://api.eu1.plainid.io

  • cURL Sample Guidelines

    In order for the relevant parameters to appear in the cURL sample, you can input the values in the interactive API console on the right in the Try It or Code Sample tabs. You can then copy the cURL sample from the Code Sample tab in the correct format.

    Security
    HTTP
    Type bearer

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

    Path parameters
    envId
    string (uuid)

    This parameter is required only when using the API to fetch Environment level Admin Audit Events.
    The parameter can be omitted when using the API to fetch Tenant level Admin Audit Events.

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

    Query parameters
    limit
    integer
    Minimum1
    Maximum1000
    Default50
    offset
    integer
    Minimum0
    Default0
    filter[timestamp][gt]
    integer

    Timestamp is in epoch time

    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
    Example{ "id": "a2f799d0-7592-45e7-aef7-8e89fd7e66df", "action": "UPDATE", "timestamp": 1693001401, "userId": "john.doe@plainid.com", "resourceType": "ROLE", "resourceId": "3494e75d-12b3-48ce-916c-1e321ad61bf6", "resourceName": "testPolicy", "parentObjectType": "AUTHZ_WS", "parentObjectId": "3494e75d-12b3-48ce-916c-1e321ad61bf6", "parentObjectName": "auth1", "oldValue": { "id": "6f69e5d3-9efb-487b-a1b6-ed00676af34c", "authWsId": "65119971-1e7c-4121-a57f-2daf90e820d2", "type": "BASIC", "authDomain": "ADVANCED", "name": "yair", "description": "qaqaqa", "isActive": true, "metadata": null, "createdTime": 1692703690054, "updatedTime": 1692703690054, "sectionsStatuses": null, "completed": null, "adminDefault": false, "restricted": false, "externalId": "6f69e5d3-9efb-487b-a1b6-ed00676af34c" }, "newValue": { "id": "6f69e5d3-9efb-487b-a1b6-ed00676af34c", "authWsId": "65119971-1e7c-4121-a57f-2daf90e820d2", "type": "BASIC", "authDomain": "ADVANCED", "name": "yair", "description": "qaqaqa", "isActive": true, "metadata": null, "createdTime": 1692703690054, "updatedTime": 1692861290496, "sectionsStatuses": null, "completed": null, "adminDefault": false, "restricted": true, "externalId": "6f69e5d3-9efb-487b-a1b6-ed00676af34c" }, "additionalData": null }
    id
    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 | null
    total
    integer

    Total number of items

    Minimum0
    limit
    integer
    Minimum0
    Maximum50
    offset
    integer
    Minimum0
    Default0
    400

    Bad request

    Expand All
    object
    code
    string
    id
    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
    id
    string
    status
    integer
    name
    string
    message
    string
    args
    object
    path
    string