v2

latestOpenAPI 3.0.02026-07-31172752.6 KB

access_states

List access states

Returns a paginated list of access states — records of who currently has (or historically had) access to which application resources, including effective time ranges.

get/api/v1/access_states

Query parameters

limitinteger

Maximum results to return (default: 20, max: 100)

cursorstring

Opaque cursor returned in the previous response's meta.next_cursor. Omit for the first page.

application_idstring

Filter by application ID

grantee_user_idstring

Filter by grantee user ID

expandstring

Comma-separated list of related objects to embed inline alongside their ID fields. Allowed values: grantee_user, application, resource, target_permissions. Embedded objects carry their own top-level fields only (no further nesting). An unknown value returns 400.

Response

Access state list

Example response

{
  "data": [
    {
      "grantee_user": {
        "deactivated_at": null,
        "departments": [
          "Engineering"
        ],
        "email": "john@example.com",
        "employment_type": "full_time",
        "first_name": "John",
        "full_name": "John Doe",
        "id": "7488a646-e31f-11e4-aace-600308960662",
        "inserted_at": "2023-01-01T00:00:00Z",
        "job_title": "Software Engineer",
        "last_name": "Doe",
        "location_city": "San Francisco",
        "manager_user_id": null,
        "status": "active",
        "teams": [
          "Engineering",
          "Backend"
        ],
        "updated_at": "2023-01-01T00:00:00Z"
      }
    }
  ],
  "meta": {
    "page": 1,
    "page_size": 20,
    "total_count": 100,
    "total_pages": 5
  }
}