Account Users

Account users are the people who have access to your account.
Use this resource to manage users on your account, including creating new users, removing users, and resetting multi-factor authentication.

Note: the account owner is always returned separately and cannot be deleted or have their MFA reset through these endpoints.

List account users

Retrieve the account owner and all users for the given account.

SecurityApiKey
Request
path Parameters
accountId
required
string <uuid> (ResourceId) <= 50 characters

The account ID.

Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21
Responses
200

Account owner and list of users.

401

Unauthorized

403

Forbidden

get/accounts/{accountId}/users
Request samples 
Response samples 
application/json
{
  • "owner": {
    },
  • "users": [
    ]
}
Create an account user
Create a new user for the given account.


SecurityApiKey 
Request 
path Parameters
accountId
required
string <uuid>  (ResourceId)   <= 50 characters 
The account ID.


 
 Example:  4f6cf35x-2c4y-483z-a0a9-158621f77a21
Request Body schema: application/json
required
email_address
required
string <email> 
The email address for the new user.


 
first_name
required
string
The first name of the new user.


 
last_name
required
string
The last name of the new user.


 
Responses 
201
Account user was created successfully.


401
Unauthorized


403
Forbidden


422
Unprocessable Entity


post/accounts/{accountId}/users
Request samples 
application/json
{
  • "email_address": "user@example.com",
  • "first_name": "string",
  • "last_name": "string"
}
Response samples 
application/json
{
  • "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "first_name": "string",
  • "last_name": "string",
  • "email_address": "user@example.com",
  • "group_memberships": [
    ]
}
Get an account user
Retrieve an account user with the given ID.


SecurityApiKey 
Request 
path Parameters
accountId
required
string <uuid>  (ResourceId)   <= 50 characters 
The account ID.


 
 Example:  4f6cf35x-2c4y-483z-a0a9-158621f77a21
userId
required
string <uuid>  (ResourceId)   <= 50 characters 
The account user ID.


 
 Example:  4f6cf35x-2c4y-483z-a0a9-158621f77a21
Responses 
200
Account user details.


401
Unauthorized


403
Forbidden


404
Not Found


get/accounts/{accountId}/users/{userId}
Request samples 
Response samples 
application/json
{
  • "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "first_name": "string",
  • "last_name": "string",
  • "email_address": "user@example.com",
  • "group_memberships": [
    ]
}
Delete an account user
Delete an account user with the given ID.


SecurityApiKey 
Request 
path Parameters
accountId
required
string <uuid>  (ResourceId)   <= 50 characters 
The account ID.


 
 Example:  4f6cf35x-2c4y-483z-a0a9-158621f77a21
userId
required
string <uuid>  (ResourceId)   <= 50 characters 
The account user ID.


 
 Example:  4f6cf35x-2c4y-483z-a0a9-158621f77a21
Responses 
200
Account user was deleted successfully.


401
Unauthorized


403
Forbidden


404
Not Found


delete/accounts/{accountId}/users/{userId}
Request samples 
Response samples 
application/json
{
  • "errors": [
    ]
}
Reset MFA for an account user
Reset multi-factor authentication for the given account user. Cannot be used on the account owner.


SecurityApiKey 
Request 
path Parameters
accountId
required
string <uuid>  (ResourceId)   <= 50 characters 
The account ID.


 
 Example:  4f6cf35x-2c4y-483z-a0a9-158621f77a21
userId
required
string <uuid>  (ResourceId)   <= 50 characters 
The account user ID.


 
 Example:  4f6cf35x-2c4y-483z-a0a9-158621f77a21
Responses 
204
MFA was reset successfully.


401
Unauthorized


403
Forbidden


404
Not Found


422
Unprocessable Entity


post/accounts/{accountId}/users/{userId}/reset-mfa
Request samples 
Response samples 
application/json
{
  • "errors": [
    ]
}
➔ Next to Adverse Actions