Get User Account
Retrieves a user by identifier (email address)
Request
URI
GET
https://{api_host}/api/v2/account/user/{id}
COPY
Path Parameters
string
id
Required
id
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
Account (User and Service Account) Operations
POST
Activate Account
POST
Add Account To Roles
POST
Add Account To User Groups
POST
Create Or Update User Account
POST
Create Service Account
POST
Deactivate Account
DELETE
Delete Account
POST
Delete Multiple Accounts
GET
Get Account
GET
Get Account Business Functions
GET
Get All Accounts
GET
Get All Service Accounts
GET
Get All User Accounts
GET
Get Service Account
GET
Get User Account
GET
Get Users With Accounts Permission
POST
Grant Account Permission
POST
Grant Permission To Accounts
POST
Invite User Accounts
POST
Remove Account From Roles
POST
Remove Account From User Groups
POST
Revoke Account Permission
POST
Revoke Permission From Accounts
PUT
Update Service Account
PUT
Update User Account
POST
Validate Accounts