Moves a user to another role. | awork API

Moves a user to another role. The user keeps workspace access under the new role.

Authentication

AuthorizationBearer

Send your token in the Authorization: Bearer <token> header. See Authentication for API keys and OAuth.

Request body Required

The move user in role payload.

application/json

userIdstringOptional

format: uuid

The id of the user to be moved to another role.

toRoleIdstringOptional

format: uuid

The id of the role the user should be moved to.

Responses

200 OK

400 Bad Request

application/json

codestringRequired

minLength: 1

The error code.

descriptionstringRequired

minLength: 1

The description of the error.

linkstringRequired

minLength: 1

The link to the API documentation page.

detailsarray of string or nullOptional

A list of details describing the error.

validationErrorsarray of object or nullOptional

If a validation error occurred, this contains the validation errors for each property.

Show 2 properties

propertystring or nullOptional

The name of the property that failed validation.

messagestring or nullOptional

The reason why this property failed validation.

traceIdstring or nullOptional

The request trace id for tracking the request.

404 Not Found

application/json

codestringRequired

minLength: 1

The error code.

descriptionstringRequired

minLength: 1

The description of the error.

linkstringRequired

minLength: 1

The link to the API documentation page.

detailsarray of string or nullOptional

A list of details describing the error.

validationErrorsarray of object or nullOptional

If a validation error occurred, this contains the validation errors for each property.

Show 2 properties

propertystring or nullOptional

The name of the property that failed validation.

messagestring or nullOptional

The reason why this property failed validation.

traceIdstring or nullOptional

The request trace id for tracking the request.