Create a new Service User

Parameter	Type	Mandatory	Description	Example
active	boolean	false
roleId	string	true	A UUID formatted string	3fa85f64-5717-4562-b3fc-2c963f66afa6
type	string	true	Values:INTERNAL_SERVICE,EXTERNAL_SERVICE
ownerOrganizationId	string	false	A UUID formatted string	3fa85f64-5717-4562-b3fc-2c963f66afa6
name	string	false
accessTokenExpirationInMinutes	integer	false
secretKeyExpirationInMinutes	integer	false	The expiration applied to secret keys of this service user, in minutes. Affects only secret keys created from this point on. Once a secret key expires it can no longer be used to log in - it does not expire the service user itself. When not set, the secret keys of this service user never expire.

Parameter

Type

Mandatory

Description

Example

active

boolean

false

roleId

string

true

A UUID formatted string

3fa85f64-5717-4562-b3fc-2c963f66afa6

type

string

true

Values:INTERNAL_SERVICE,EXTERNAL_SERVICE

ownerOrganizationId

string

false

A UUID formatted string

3fa85f64-5717-4562-b3fc-2c963f66afa6

name

string

false

accessTokenExpirationInMinutes

integer

false

secretKeyExpirationInMinutes

integer

false

The expiration applied to secret keys of this service user, in minutes. Affects only secret keys created from this point on. Once a secret key expires it can no longer be used to log in - it does not expire the service user itself. When not set, the secret keys of this service user never expire.

The below table describes the response parameters:

Parameter	Type	Description	Example
headers	object
body	object
body.active	boolean
body.roleId	string	A UUID formatted string	3fa85f64-5717-4562-b3fc-2c963f66afa6
body.type	string	Values:INTERNAL_SERVICE,EXTERNAL_SERVICE
body.ownerOrganizationId	string	A UUID formatted string	3fa85f64-5717-4562-b3fc-2c963f66afa6
body.name	string
body.accessTokenExpirationInMinutes	integer
body.secretKeyExpirationInMinutes	integer	The expiration applied to secret keys of this service user, in minutes. Affects only secret keys created from this point on. Once a secret key expires it can no longer be used to log in - it does not expire the service user itself. When not set, the secret keys of this service user never expire.
body.id	string
body.secretKeyData	object
body.secretKeyData.id	string
body.secretKeyData.creationTime	string
body.secretKeyData.expirationTime	string	The time this secret key expires, after which it can no longer be used to log in. Null when the secret key never expires. Secret keys that already expired are not returned at all.
body.secretKeyData.secretKey	string
statusCode	object
statusCode.is4xxClientError	boolean
statusCode.error	boolean
statusCode.is5xxServerError	boolean
statusCode.is1xxInformational	boolean
statusCode.is2xxSuccessful	boolean
statusCode.is3xxRedirection	boolean
statusCodeValue	integer

400Code : SERVICE_TYPE_NOT_ALLOWED, Details: [attributeName, value] Code : MISSING_PARAMETERS, Details: [parameters] Code : INVALID_SECRET_KEY_EXPIRATION, Details: [secretKeyExpirationInMinutes]

401Code : TOKEN_NOT_VALID, Details: []

403Code : ACCESS_DENIED, Details: []

404Code : OWNER_ORGANIZATION_NOT_FOUND, Details: [id] Code : PERMISSIONS_NOT_FOUND, Details: [ids]

409Code : SERVICE_NAME_ALREADY_EXISTS, Details: [name] Code : ROLE_ALREADY_EXISTS, Details: [name]

500Code : INTERNAL_SERVER_ERROR, Details: []

504Code : GATEWAY_TIMEOUT, Details: []