Get User

Get User

Retrieves a user by identifier (email address)

Request
URI
GET
https://{api_host}/api/v2/user/{id}
COPY
Path Parameters
string
id
Required

id

Authentication
This operation uses the following authentication methods.
Responses
200

successful operation

Returns UserModel of type(s) application/json 
{
    "identifier": "string",
    "customer": "string",
    "ssoId": "string",
    "lastSuccessfulLogin": 0,
    "groups": [
        "string"
    ],
    "userGroups": [
        {
            "id": "04e5fd3a-c916-45aa-923c-2fa02e9eddac",
            "name": "string",
            "customer": "string",
            "users": [
                "string"
            ],
            "userCount": 0,
            "properties": {
                "nameEditable": false,
                "usersEditable": false,
                "rolesEditable": false
            },
            "description": "string",
            "roles": [
                "RoleDTO Object"
            ]
        }
    ],
    "roles": [
        {
            "sampleLinkedGroups": [
                "UserGroup Object"
            ],
            "linkedGroupsCount": 0,
            "sampleLinkedAccounts": [
                "string"
            ],
            "linkedAccountsCount": 0,
            "restrictedPermissions": [
                "string"
            ],
            "properties": {
                "nameEditable": false,
                "usersRemovable": false,
                "usersAddable": false,
                "permsEditable": false,
                "deletable": false
            },
            "permissions": [
                "string"
            ],
            "name": "string",
            "id": "string",
            "description": "string",
            "createdEpochMillis": 0,
            "lastUpdatedMs": 0,
            "lastUpdatedAccountId": "string",
            "customer": "string"
        }
    ]
}
string
identifier
Required

The unique identifier of this user, which must be their valid email address

string
customer
Required

The id of the customer to which this user belongs

string
ssoId
Optional

ssoId

integer As int64 As int64
lastSuccessfulLogin
Optional

lastSuccessfulLogin

array of string
groups
Required

The permissions granted to this user

array of UserGroup
userGroups
Required

The list of user groups the user belongs to

array of RoleDTO
roles
Optional

roles


On This Page
User Operations
POST
Add User To User Groups
POST
Create User
POST
Delete Multiple Users
DELETE
Delete User
GET
Get All Users
GET
Get User
GET
Get User Business Functions
POST
Grant Permission To Users
POST
Grant User Permission
POST
Invite Users
POST
Remove User From User Groups
POST
Revoke Permission From Users
POST
Revoke User Permission
PUT
Update User
POST
Validate Users