Admin API

Create an Admin API client

An actor triggers this event when they attempt to create an API client for the Admin API. The name and scopes are set in a subsequent update, so they are not included in this event. When the outcome is DENIED, the actor did not have permission to create the client.

typestring

Default value: CREATE_ADMIN_API_CLIENT

Available values: The only valid value is CREATE_ADMIN_API_CLIENT.

Example

{
  "id": ...,
  "timestamp": ...,
  "actor": ...,
  "target": ...,
  "action": {
    "type": "CREATE_ADMIN_API_CLIENT"
  },
  "outcome": ...,
  "context": ...
}

JSON

Update an Admin API client

An actor triggers this event when they attempt to update an API client for the Admin API. When the outcome is DENIED, the actor did not have permission to update the client.

typestring

Default value: UPDATE_ADMIN_API_CLIENT

Available values: The only valid value is UPDATE_ADMIN_API_CLIENT.

changed_fieldsstring[]

Optional

The fields the actor requested changes for in this update.

Available values:

NAME: The name of the API client.
SCOPES: The scopes granted to the API client.
SECRET: The client secret was regenerated.

old_namestring

Optional

The previous name of the API client.

new_namestring

Optional

The new name of the API client.

old_scopesstring[]

Optional

The previous scopes granted to the API client.

new_scopesstring[]

Optional

The new scopes granted to the API client.

Example

{
  "id": ...,
  "timestamp": ...,
  "actor": ...,
  "target": ...,
  "action": {
    "type": "UPDATE_ADMIN_API_CLIENT",
    "changed_fields": [
      "NAME",
      "SCOPES",
      "SECRET"
    ],
    "old_name": "My Integration",
    "new_name": "My Updated Integration",
    "old_scopes": [
      "admin:team:read"
    ],
    "new_scopes": [
      "admin:team:read"
    ]
  },
  "outcome": ...,
  "context": ...
}

JSON

Delete an Admin API client

An actor triggers this event when they attempt to delete an API client for the Admin API. When the outcome is DENIED, the actor did not have permission to delete the client.

typestring

Default value: DELETE_ADMIN_API_CLIENT

Available values: The only valid value is DELETE_ADMIN_API_CLIENT.

Example

{
  "id": ...,
  "timestamp": ...,
  "actor": ...,
  "target": ...,
  "action": {
    "type": "DELETE_ADMIN_API_CLIENT"
  },
  "outcome": ...,
  "context": ...
}

JSON