data structure:
| Field | Type | Description |
|---|---|---|
id | string | The UUID of the revocation |
affected_user | object | The user whose access is being revoked |
requested_by | object | The user who initiated the revocation |
application | object | The application the access is being revoked from |
resource | object | The specific resource within the application |
permissions | array | The permissions being revoked, each with an id and title |
revocation_reason | string | The reason provided for the revocation |
created_at | string | ISO 8601 timestamp of when the revocation was created |
permissions reflects the permissions as they were when the revocation was created. The set can change over the course of the revocation, so it may not match the permissions actually removed by the time the revocation completes — treat it as the creation-time snapshot.- revocation.created
- revocation.rejected
- revocation.revoked
Fired when an access revocation is initiated.
{
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"affected_user": {
"id": "8b15e986-84ac-4dbc-8e66-c82ebf3d2fc2",
"email": "john.doe@example.com",
"full_name": "John Doe"
},
"application": {
"id": "c4d5e6f7-a8b9-0123-cdef-456789abcdef",
"tags": [
"Foo",
"Bar",
"Baz"
],
"title": "GitHub"
},
"created_at": "2022-07-13T23:42:00Z",
"permissions": [
{
"id": "e6f7a8b9-c0d1-2345-efab-6789abcdef01",
"title": "Read Access"
}
],
"requested_by": {
"id": "5a3e57df-2d08-46be-b5bd-b3ea505a3d26",
"email": "admin@example.com",
"full_name": "Admin User"
},
"resource": {
"id": "d5e6f7a8-b9c0-1234-defa-56789abcdef0",
"title": "Engineering Team"
},
"revocation_reason": "Employee offboarded"
}
Fired when a provisioner is unable to revoke access. This can happen when an integration fails or a manual provisioner rejects the deprovisioning step.The
data object includes additional fields:| Field | Type | Description |
|---|---|---|
provisioner | object | The actor who attempted the revocation |
reject_reason | string | The reason given for the rejection |
rejected_at | string | ISO 8601 timestamp of when the revocation was rejected |
{
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"affected_user": {
"id": "8b15e986-84ac-4dbc-8e66-c82ebf3d2fc2",
"email": "john.doe@example.com",
"full_name": "John Doe"
},
"application": {
"id": "c4d5e6f7-a8b9-0123-cdef-456789abcdef",
"tags": [
"Foo",
"Bar",
"Baz"
],
"title": "GitHub"
},
"created_at": "2022-07-12T23:42:00Z",
"permissions": [
{
"id": "e6f7a8b9-c0d1-2345-efab-6789abcdef01",
"title": "Read Access"
}
],
"provisioner": {
"id": "7c9e1f2a-3b4d-5e6f-8a9b-0c1d2e3f4a5b",
"email": "provisioner@example.com",
"full_name": "Provisioner User",
"type": "manual"
},
"reject_reason": "Access not available for this resource",
"rejected_at": "2022-07-13T23:42:00Z",
"requested_by": {
"id": "5a3e57df-2d08-46be-b5bd-b3ea505a3d26",
"email": "admin@example.com",
"full_name": "Admin User"
},
"resource": {
"id": "d5e6f7a8-b9c0-1234-defa-56789abcdef0",
"title": "Engineering Team"
},
"revocation_reason": "Employee offboarded"
}
Fired when access has been successfully revoked.The
data object includes additional fields:| Field | Type | Description |
|---|---|---|
provisioner | object | The actor who performed the revocation, including a type field (manual or automation) |
revoked_at | string | ISO 8601 timestamp of when access was revoked |
{
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"affected_user": {
"id": "8b15e986-84ac-4dbc-8e66-c82ebf3d2fc2",
"email": "john.doe@example.com",
"full_name": "John Doe"
},
"application": {
"id": "c4d5e6f7-a8b9-0123-cdef-456789abcdef",
"tags": [
"Foo",
"Bar",
"Baz"
],
"title": "GitHub"
},
"created_at": "2022-07-12T23:42:00Z",
"permissions": [
{
"id": "e6f7a8b9-c0d1-2345-efab-6789abcdef01",
"title": "Read Access"
}
],
"provisioner": {
"id": "7c9e1f2a-3b4d-5e6f-8a9b-0c1d2e3f4a5b",
"email": "provisioner@example.com",
"full_name": "Provisioner User",
"type": "manual"
},
"requested_by": {
"id": "5a3e57df-2d08-46be-b5bd-b3ea505a3d26",
"email": "admin@example.com",
"full_name": "Admin User"
},
"resource": {
"id": "d5e6f7a8-b9c0-1234-defa-56789abcdef0",
"title": "Engineering Team"
},
"revocation_reason": "Employee offboarded",
"revoked_at": "2022-07-13T23:42:00Z"
}