Sign in
apiUsers

Returns the API user with the specified id.

<Check title="Required Permissions" icon="key">The user must be an admin or have workspace-manage-config:read permissions.</Check>

get/apiusers/{apiUserId}

Path parameters

apiUserIdstring uuid required

The id of the API user.

Headers

Authorizationstring required

Bearer authentication

Response

OK

namestring required

The name of the API user.

roleIdstring uuid nullable

The role the user should be in. If no role is specified, the user will become an admin.

clientIdstring nullable

The client id this API user belongs to.

idstring uuid

The id of the API user.

createdOnstring date-time

The date this user was created.

createdBystring uuid

The id of the user who created this user.

updatedOnstring date-time

The date when this user was last updated.

updatedBystring uuid

The id of the user who updated the entity.

Changes

No recorded changes to this endpoint across all 5 revisions of this API.