Skip to main content
Version: v41

api_client

API client

idstring<uuid>
secretstring
namestring
createdstring<date-time>

When the object was created

Example: 2017-01-01T15:05:05Z
updatedstring<date-time>

When the object was updated

Example: 2017-01-01T15:05:05Z
updated_bystring<uuid>

ID of the user who updated the object

Example: eef4aefc-d64e-4c2c-aba4-4914c86ce059
authorstring<uuid>

ID of the user who originally authored the object

Example: eef4aefc-d64e-4c2c-aba4-4914c86ce059
roles object[]

List of roles possessed by the API client

  • Array [
  • idstringrequired

    Role ID

    namestring

    Role name, ignored by server in requests.

    deletedboolean

    True if role is deleted

  • ]
  • oauth_client_idstring

    ID for OAuth2 client, used for authentication

    oauth_client_secretstring

    Secret for OAuth2 client, used for authentication

    api_client
    {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "secret": "string",
    "name": "string",
    "created": "2017-01-01T15:05:05Z",
    "updated": "2017-01-01T15:05:05Z",
    "updated_by": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
    "author": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
    "roles": [
    {
    "id": "string",
    "name": "string",
    "deleted": true
    }
    ],
    "oauth_client_id": "string",
    "oauth_client_secret": "string"
    }