Update Service User

patch

https://example.com/ums/v2/services/{id}

Update Service User

Performs partial update, if a field is specified in the request it will be updated

Request Body Parameters:

Parameter	Type	Mandatory	Description	Example
active	boolean	false
roleId	string	false	A UUID formatted string	3fa85f64-5717-4562-b3fc-2c963f66afa6
Path Parameters:

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

This API requires UMS_SERVICES_UPDATE_SERVICE_USER permission(s).

Responses

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
id	string
secretKeys	array
secretKeys[index]	array
secretKeys[index].id	string
secretKeys[index].creationTime	string

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

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