API v1 ReferenceAPI Users

Returns all API users.

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

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Response

OK
namestring>=1 character
The name of the API user.
roleIdstring or nullOptionalformat: "uuid"
The role the user should be in. If no role is specified, the user will become an admin.
clientIdstring or nullOptional
The client id this API user belongs to.
idstringOptionalformat: "uuid"
The id of the API user.
createdOnstringOptionalformat: "date-time"
The date this user was created.
createdBystringOptionalformat: "uuid"
The id of the user who created this user.
updatedOnstringOptionalformat: "date-time"
The date when this user was last updated.
updatedBystringOptionalformat: "uuid"
The id of the user who updated the entity.