User account management and self-service profile operations.

GET/me

Get current user profile

Returns the profile and organization membership details of the currently authenticated user.

Responses

Responses

The information about the current identity is returned.

Content-Type

application/json

{

  

"root": {

  

},

  

"user": {

  

  

"id": "A1B2C3D4E5",

  

  

"email": "alice@example.com",

  

  

"givenName": "string",

  

  

"familyName": "string",

  

  

"displayName": "string",

  

  

"createdAt": "string",

  

  

"createdBy": "A1B2C3D4E5",

  

  

"updatedAt": "string",

  

  

"updatedBy": "A1B2C3D4E5"

  

},

  

"serviceAccount": {

  

  

"id": "A1B2C3D4E5",

  

  

"username": "ci-deploy-bot",

  

  

"description": "string",

  

  

"createdAt": "string",

  

  

"createdBy": "A1B2C3D4E5",

  

  

"updatedAt": "string",

  

  

"updatedBy": "A1B2C3D4E5"

  

}

}

PATCH/me

Update my profile

Modifies the authenticated user's profile information such as their display name or preferences.

Request Body

application/json

{

  

"email": "alice@example.com",

  

"givenName": "string",

  

"familyName": "string",

  

"displayName": "string"

}

Responses

Responses

The user profile was updated successfully.

Content-Type

application/json

{

  

"root": {

  

},

  

"user": {

  

  

"id": "A1B2C3D4E5",

  

  

"email": "alice@example.com",

  

  

"givenName": "string",

  

  

"familyName": "string",

  

  

"displayName": "string",

  

  

"createdAt": "string",

  

  

"createdBy": "A1B2C3D4E5",

  

  

"updatedAt": "string",

  

  

"updatedBy": "A1B2C3D4E5"

  

},

  

"serviceAccount": {

  

  

"id": "A1B2C3D4E5",

  

  

"username": "ci-deploy-bot",

  

  

"description": "string",

  

  

"createdAt": "string",

  

  

"createdBy": "A1B2C3D4E5",

  

  

"updatedAt": "string",

  

  

"updatedBy": "A1B2C3D4E5"

  

}

}

GET/me/emails

List my email addresses

Returns all email addresses associated with the authenticated user's account, including their verification status.

Parameters

limitinteger

limit

The maximum number of items to list.

Type

integer

Format

"int32"

Minimum

0

Maximum

100

Default

100

markerstring

marker

The pagination token returned from the previous list operation.

Type

string

Responses

Responses

The email addresses of the current identity are returned.

Content-Type

application/json

{

  

"items": [

  

  

{

  

  

  

"userId": "A1B2C3D4E5",

  

  

  

"email": "alice@example.com",

  

  

  

"verifiedAt": "string",

  

  

  

"createdAt": "string",

  

  

  

"createdBy": "A1B2C3D4E5",

  

  

  

"updatedAt": "string",

  

  

  

"updatedBy": "A1B2C3D4E5"

  

  

}

  

],

  

"marker": "string"

}

POST/me/emails

Add an email address

Adds a new email address to the current user's account and sends a verification email.

Request Body

application/json

{

  

"email": "alice@example.com"

}

Responses

Responses

The email address was added and a verification email has been sent.

Content-Type

application/json

{

  

"userId": "A1B2C3D4E5",

  

"email": "alice@example.com",

  

"verifiedAt": "string",

  

"createdAt": "string",

  

"createdBy": "A1B2C3D4E5",

  

"updatedAt": "string",

  

"updatedBy": "A1B2C3D4E5"

}

GET/me/logins

List my logins

Returns all active (non-expired) logins for the currently authenticated user, including device, IP address, and user agent information.

Responses

Responses

The logins of the current user are returned.

Content-Type

application/json

{

  

"items": [

  

  

{

  

  

  

"id": "A1B2C3D4E5",

  

  

  

"deviceId": "string",

  

  

  

"authTime": "string",

  

  

  

"lastUsedAt": "string",

  

  

  

"expiresAt": "string",

  

  

  

"remoteIp": "string",

  

  

  

"userAgent": "string",

  

  

  

"isCurrent": true

  

  

}

  

]

}

DELETE/me/logins/{loginId}

Revoke a login

Revokes a specific active login for the currently authenticated user. This immediately invalidates the login's access token.

Responses

Responses

The requested operation was done successfully.

GET/me/trusted-devices

List my trusted devices

Returns all active (non-expired) trusted devices for the currently authenticated user. Trusted devices bypass two-factor authentication challenges.

Responses

Responses

The trusted devices of the current user are returned.

Content-Type

application/json

{

  

"items": [

  

  

{

  

  

  

"id": "A1B2C3D4E5",

  

  

  

"deviceId": "string",

  

  

  

"expiresAt": "string",

  

  

  

"createdAt": "string",

  

  

  

"remoteIp": "string",

  

  

  

"userAgent": "string"

  

  

}

  

]

}

DELETE/me/trusted-devices/{trustedDeviceId}

Revoke a trusted device

Revokes a specific trusted device for the currently authenticated user. Future logins from this device will require two-factor authentication.

Responses

Responses

The requested operation was done successfully.

GET/me/teams

List my teams

Returns all teams that the authenticated user is a member of, including their role within each team.

Responses

Responses

The teams of the current identity are returned.

Content-Type

application/json

{

  

"items": [

  

  

{

  

  

  

"id": "A1B2C3D4E5",

  

  

  

"organizationId": "A1B2C3D4E5",

  

  

  

"name": "string",

  

  

  

"createdAt": "string",

  

  

  

"createdBy": "A1B2C3D4E5",

  

  

  

"updatedAt": "string",

  

  

  

"updatedBy": "A1B2C3D4E5",

  

  

  

"defaultRoleId": "A1B2C3D4E5"

  

  

}

  

]

}

GET/org/users

List users

Returns a paginated list of all user accounts in the organization.

Parameters

limitinteger

limit

The maximum number of items to list.

Type

integer

Format

"int32"

Minimum

0

Maximum

100

Default

100

markerstring

marker

The pagination token returned from the previous list operation.

Type

string

Responses

Responses

A list of users is returned.

Content-Type

application/json

{

  

"items": [

  

  

{

  

  

  

"id": "A1B2C3D4E5",

  

  

  

"email": "alice@example.com",

  

  

  

"givenName": "string",

  

  

  

"familyName": "string",

  

  

  

"displayName": "string",

  

  

  

"createdAt": "string",

  

  

  

"createdBy": "A1B2C3D4E5",

  

  

  

"updatedAt": "string",

  

  

  

"updatedBy": "A1B2C3D4E5"

  

  

}

  

],

  

"marker": "string"

}

POST/org/users

Create a user

Creates a new user account in the platform with the specified profile information and credentials.

Request Body

application/json

{

  

"email": "alice@example.com",

  

"givenName": "string",

  

"familyName": "string",

  

"displayName": "string"

}

Responses

Responses

The user was created successfully.

Content-Type

application/json

{

  

"id": "A1B2C3D4E5",

  

"email": "alice@example.com",

  

"givenName": "string",

  

"familyName": "string",

  

"displayName": "string",

  

"createdAt": "string",

  

"createdBy": "A1B2C3D4E5",

  

"updatedAt": "string",

  

"updatedBy": "A1B2C3D4E5"

}

GET/org/users/{user}

Describe a user

Returns the full details of a user account, including their profile information and account status.

Responses

Responses

The information about the user is returned.

Content-Type

application/json

{

  

"id": "A1B2C3D4E5",

  

"email": "alice@example.com",

  

"givenName": "string",

  

"familyName": "string",

  

"displayName": "string",

  

"createdAt": "string",

  

"createdBy": "A1B2C3D4E5",

  

"updatedAt": "string",

  

"updatedBy": "A1B2C3D4E5"

}

DELETE/org/users/{user}

Delete a user

Permanently removes a user account and revokes all their active sessions, organization memberships, and team assignments.

Responses

Responses

The requested operation was done successfully.

PATCH/org/users/{user}

Update a user

Modifies a user account's profile information or account settings.

Request Body

application/json

{

  

"email": "alice@example.com",

  

"givenName": "string",

  

"familyName": "string",

  

"displayName": "string"

}

Responses

Responses

The user was updated successfully.

Content-Type

application/json

{

  

"id": "A1B2C3D4E5",

  

"email": "alice@example.com",

  

"givenName": "string",

  

"familyName": "string",

  

"displayName": "string",

  

"createdAt": "string",

  

"createdBy": "A1B2C3D4E5",

  

"updatedAt": "string",

  

"updatedBy": "A1B2C3D4E5"

}

DELETE/org/users/{user}/mfa

Reset user MFA

Deletes all MFA configurations (TOTP and recovery codes) for the specified user
and revokes all their active sessions. The user will be required to re-authenticate
and set up MFA again.

Responses

Responses

The requested operation was done successfully.

POST/org/users/{user}/password

Change user password

The current password must be provided in the request body.
For organization administrators, to reset password for a user without their current password, use the ResetPassword operation instead.

Request Body

application/json

{

  

"currentPassword": "string",

  

"newPassword": "string"

}

Responses

Responses

The requested operation was done successfully.

POST/org/users/{user}/password/reset

Reset user password

Admin operation that generates a new temporary password for a user. To change the current user's own password, use ChangePassword instead.

Responses

Responses

The password was reset successfully.

Content-Type

application/json

{

  

"password": "string"

}