User Management

List organization users

get

List all users for the current organization.

Required scopes

This endpoint requires the following scopes:

• : Allows organization's users

Authorizations

every

OAuth2authorizationCodeRequired

Authorization URL: Token URL:

Responses

200

Default Response

application/json

get

/api/v1/users

HTTPcURLJavaScriptPython

GET /api/v1/users HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

200

Default Response

{
  "records": [
    {
      "id": "text",
      "email": "text"
    }
  ]
}

List organization invitations

get

List all pending invitations for the current organization.

Required scopes

This endpoint requires the following scopes:

• : Allows organization's users

Authorizations

every

OAuth2authorizationCodeRequired

Authorization URL: Token URL:

Responses

200

Default Response

application/json

get

/api/v1/users/invitations

HTTPcURLJavaScriptPython

GET /api/v1/users/invitations HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

200

Default Response

{
  "records": [
    {
      "id": "text",
      "email": "[email protected]",
      "role": "ORG_OWNER",
      "createdAt": "text"
    }
  ]
}

Invite user to organization

post

Invite a new user to the current organization via Auth0.

Required scopes

This endpoint requires the following scopes:

• : Allows organization's users

Authorizations

every

OAuth2authorizationCodeRequired

Authorization URL: Token URL:

Body

application/json

emailstring · emailRequiredPattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$

rolestring · enumRequiredPossible values:

Responses

201

Default Response

application/json

post

/api/v1/users/invitations

HTTPcURLJavaScriptPython

POST /api/v1/users/invitations HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 45

{
  "email": "[email protected]",
  "role": "ORG_OWNER"
}

201

Default Response

{
  "id": "text",
  "invitationUrl": "text"
}

Delete organization invitation

delete

Delete a pending invitation from the organization. Only users with MANAGE_USERS permission can delete invitations.

Required scopes

This endpoint requires the following scopes:

• : Allows organization's users

Authorizations

every

OAuth2authorizationCodeRequired

Authorization URL: Token URL:

Path parameters

invitationIdstringRequired

Responses

204

Default Response

delete

/api/v1/users/invitations/{invitationId}

HTTPcURLJavaScriptPython

DELETE /api/v1/users/invitations/{invitationId} HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

204

Default Response

No content

Get user by ID

get

Get a specific user by their ID from the current organization.

Required scopes

This endpoint requires the following scopes:

• : Allows organization's users

Authorizations

every

OAuth2authorizationCodeRequired

Authorization URL: Token URL:

Path parameters

userIdstringRequired

Responses

200

Default Response

application/json

idstringRequired

emailstringRequired

rolestring · enumRequiredPossible values:

get

/api/v1/users/{userId}

HTTPcURLJavaScriptPython

GET /api/v1/users/{userId} HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

200

Default Response

{
  "id": "text",
  "email": "text",
  "role": "ORG_OWNER"
}

Delete user from organization

delete

Delete a user from the organization. Only users with MANAGE_USERS permission can delete users.

Required scopes

This endpoint requires the following scopes:

• : Allows organization's users

Authorizations

every

OAuth2authorizationCodeRequired

Authorization URL: Token URL:

Path parameters

userIdstringRequired

Responses

204

Default Response

delete

/api/v1/users/{userId}

HTTPcURLJavaScriptPython

DELETE /api/v1/users/{userId} HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

204

Default Response

No content

Update user information

patch

Update user information in the organization. Only basic profile fields can be updated.

Required scopes

This endpoint requires the following scopes:

• : Allows organization's users

Authorizations

every

OAuth2authorizationCodeRequired

Authorization URL: Token URL:

Path parameters

userIdstringRequired

Body

application/json

emailstring · emailRequiredPattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$

rolestring · enumRequiredPossible values:

Responses

200

Default Response

application/json

idstringRequired

emailstringRequired

rolestring · enumRequiredPossible values:

patch

/api/v1/users/{userId}

HTTPcURLJavaScriptPython

PATCH /api/v1/users/{userId} HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 45

{
  "email": "[email protected]",
  "role": "ORG_OWNER"
}

200

Default Response

{
  "id": "text",
  "email": "text",
  "role": "ORG_OWNER"
}

Reset user password

post

Reset a user's password. Users can reset their own password, organization managers can reset passwords for users in their organization, and super admins can reset any user's password.

Required scopes

This endpoint requires the following scopes:

• : Allows organization's users

Authorizations

every

OAuth2authorizationCodeRequired

Authorization URL: Token URL:

Path parameters

userIdstringRequired

Responses

200

Default Response

application/json

ticketstringRequired

post

/api/v1/users/{userId}/password-reset-ticket

HTTPcURLJavaScriptPython

POST /api/v1/users/{userId}/password-reset-ticket HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

200

Default Response

{
  "ticket": "text"
}

Get MFA enrollment ticket

post

Get an MFA enrollment ticket for the current user or a specified user (requires appropriate permissions).

Required scopes

This endpoint requires the following scopes:

• : Allows organization's users

Authorizations

every

OAuth2authorizationCodeRequired

Authorization URL: Token URL:

Path parameters

userIdstringRequired

Responses

200

Default Response

application/json

ticketstringRequired

post

/api/v1/users/{userId}/mfa-enrollment-ticket

HTTPcURLJavaScriptPython

POST /api/v1/users/{userId}/mfa-enrollment-ticket HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

200

Default Response

{
  "ticket": "text"
}