Get User

GET /auth/users/{userId}

Get a specific user from the caller's org

Required Permissions

Name
Conditions

Auth:Users:Read

Always Required

Parameters

userId *

the ID of the user to get

Example

auth/users/us-em7bu-m6c48-hdqoobj7dj24pko

Responses

  • See Common Errors for common errors.

  • See User Management Errors for user management specific errors.

Success - The requested user

{
    "userId": "us-xxxx-xxxx-xxxxxxxx",
    "kind": "CustomerEmployee",
    "username": "[email protected]",
    "name": "Elon Musk",
    "orgId": "or-xxxx-xxxx-xxxxxxxx",
    "isActive": true,
    "isRegistered": true,
    "permissionAssignments": [],
}

Last updated