Update Service User

Parameter	Type	Mandatory	Description	Example
active	boolean	false
roleId	string	false	A UUID formatted string	3fa85f64-5717-4562-b3fc-2c963f66afa6
secretKeyExpirationInMinutes	integer	false	The expiration applied to secret keys of this service user, in minutes. Affects only secret keys created from this point on - secret keys that already exist keep their original expiration. Pass null to stop expiring new secret keys. It does not expire the service user itself.
Path Parameters:

Parameter

Type

Mandatory

Description

Example

active

boolean

false

roleId

string

false

A UUID formatted string

3fa85f64-5717-4562-b3fc-2c963f66afa6

secretKeyExpirationInMinutes

integer

false

The expiration applied to secret keys of this service user, in minutes. Affects only secret keys created from this point on - secret keys that already exist keep their original expiration. Pass null to stop expiring new secret keys. It does not expire the service user itself.

Path Parameters:

Parameter	Type	Mandatory	Description	Example
id	string	true	Service User ID that needs to be updated	3fa85f64-5717-4562-b3fc-2c963f66afa6

Parameter

Type

Mandatory

Description

Example

string

true

Service User ID that needs to be updated

3fa85f64-5717-4562-b3fc-2c963f66afa6

The below table describes the response parameters:

Parameter	Type	Description	Example
active	boolean
roleId	string	A UUID formatted string	3fa85f64-5717-4562-b3fc-2c963f66afa6
type	string	Values:INTERNAL_SERVICE,EXTERNAL_SERVICE
ownerOrganizationId	string	A UUID formatted string	3fa85f64-5717-4562-b3fc-2c963f66afa6
name	string
accessTokenExpirationInMinutes	integer
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.
id	string
secretKeys	array
secretKeys[index]	array
secretKeys[index].id	string
secretKeys[index].creationTime	string
secretKeys[index].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.

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

401Code : TOKEN_NOT_VALID, Details: []

403Code : ACCESS_DENIED, Details: []

404Code : SERVICE_USER_NOT_FOUND, Details: [id] Code : ROLE_NOT_FOUND_IN_SUPPORTED_TYPES, Details: [id, types]

500Code : INTERNAL_SERVER_ERROR, Details: []

504Code : GATEWAY_TIMEOUT, Details: []