Skip to main content

Create technical user

Create a new technical user for this organization.

Header Parameters
organization-id uuid REQUIRED

ID of organization context this request belongs to.

X-API-RESOURCE-VERSION string REQUIRED

Possible values: [2]

Resource version header

Request Body REQUIRED
name string REQUIRED

Possible values: 1 ≤ length ≤ 50

Responses
201

Technical user successfully created

Schema OPTIONAL
clientId string OPTIONAL

OAuth 'client_id' parameter to be used for requests to the token endpoint.

credentialType string OPTIONAL

Possible values: [ACCESS_TOKEN, REFRESH_TOKEN]

The 'ACCESS_TOKEN' means that a long living access token has been issued for the user. In case of 'REFRESH_TOKEN' a refresh token was issued.

deleted boolean OPTIONAL
id uuid OPTIONAL
name string OPTIONAL
tokenEndpoint uri OPTIONAL

OAuth endpoint to exchange an access token for a refresh token.

accessToken string OPTIONAL

Token to access the API.

clientSecret string OPTIONAL

OAuth 'client_secret' parameter to be used for requests to the token endpoint.

expiresIn int64 OPTIONAL

The lifetime in seconds of the access token.

refreshExpiresIn int64 OPTIONAL

The lifetime in seconds of the refresh token.

refreshToken string OPTIONAL

Token to fetch a new access token.

400

Bad Request (e.g. element not found or resource conflict).

Schema OPTIONAL
message string OPTIONAL
timestamp date-time OPTIONAL
traceId string OPTIONAL
type string OPTIONAL
403

Missing permission

Schema OPTIONAL
message string OPTIONAL
timestamp date-time OPTIONAL
traceId string OPTIONAL
type string OPTIONAL
500

Internal server error (Internal service communication or process error).

Schema OPTIONAL
message string OPTIONAL
timestamp date-time OPTIONAL
traceId string OPTIONAL
type string OPTIONAL