Skip Navigation Links

Api Clients

Get API clients

Requires authentication via bearer.

Returns all api clients that can be managed by the current actor.

Query Params

page_number integer

requested page for offset based pagination. Refer to our general "pagination" concept for more information.

page_limit integer

The maximum number of items to be contained in the response array. Refer to our general "pagination" concept for more information.

embed string[]

Response Body

200 OK

Create API clients

Requires authentication via bearer.

Create an api client with all the necessary information. Creating an api client also will create a technical user that is visible in the app. The first and lastname of the technical user can be set in the technical_user object.

Request Body

client_id stringrequired

The display name of the api client.

description string

A description of the api client, to add any notes or context.

role stringrequired
legacy_roles object[]

Legacy roles are not used anymore and are only kept for backwards compatibility with APIs that existed before V4.

technical_user objectrequired

Properties of the technical user that is created alongside the api client and is visible in the app.

Response Body

200 OK

Error Codes

  • INVALID_CLIENT_ID
  • CLIENT_ID_ALREADY_EXISTS
  • INVALID_DESCRIPTION

Update API clients

Requires authentication via bearer.

Update multiple api clients. For the actual update semantics consult the documentation of the single api client update endpoint.

Request Body

items object[]

Response Body

200 OK

Get single API client

Requires authentication via bearer.

Returns a single api client that can be managed by the current actor.

Path Params

id stringrequired

The id of the api client.

Query Params

embed string[]

Response Body

200 OK

Update API client

Requires authentication via bearer.

Update an api client with the specified id.

Path Params

id stringrequired

The id of the api client.

Request Body

enabled boolean
description string
role string
legacy_roles object[]

Legacy roles are not used anymore and are only kept for backwards compatibility with APIs that existed before V4.

technical_user object

Response Body

200 OK

Error Codes

  • INVALID_DESCRIPTION
  • ACTOR_MUST_NOT_CHANGE_ITSELF

Delete API client

Requires authentication via bearer.

Delete the api client with the specified id.

Path Params

id stringrequired

The id of the api client.

Response Body

200 OK