Retrieve user

Retrieve user with specified identifier string.

SecuritySecretApiKey or JWT
Request
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

Resource identifier string.

Responses
200

User retrieved.

Response Schema: application/json
email
required
string <email> <= 100 characters

Email address of the user.

firstName
required
string

User's first name.

lastName
required
string

User's last name.

id
string <= 50 characters

ID of the user.

businessPhone
string

User's business phone number.

mobilePhone
string

User's mobile phone number.

password
string <password>

User's password. If this value is not provided, a password reset email is sent.

permissions
Array of strings <operationId>

Permissions that the user has within organizations. Use the wildcard character * for full access.

computedPermissions
Array of strings <operationId>

All user permissions and roles. Use these permissions to emulate the user.

createdTime
string <date-time> (CreatedTime)

Date and time which is set automatically when the resource is created.

updatedTime
string <date-time> (UpdatedTime)

Date and time which updates automatically when the resource is updated.

loginTime
string <date-time>

Date and time when the user last logged in.

reportingCurrency
string

User's currency code in ISO 4217 format. This value is used for reports.

availableCurrencies
Array of strings

Array of reporting currencies that are enabled for the merchant.

totpRequired
boolean

Specifies whether two-factor authentification is enabled for the user.

totpSecret
string

User's Time-based One-Time Password (TOTP) key for the authentification application, if TOTP is enabled..

totpUrl
string <url>

QR-code link that redirects the user to the authentification application, if TOTP is enabled.

status
string

Status of the user's account.

Enum: "active" "inactive" "pending-confirmation"
country
string

User's country of residence in ISO 3166 alpha-2 country code. For examples, see ISO.org.

preferences
object

User preferences, such as: timezone, language, and more. This is an object with custom properties.

roleIds
Array of strings

Role IDs associated with the user. Role IDs specify the roles that the user performs within the organization. For example, the user may be an organization admin.

allowedIps
Array of strings or null <ip> (AllowedIps)

List of IP addresses that are permitted access. Private subnets are prohibited. To remove restrictions, set this value to null.

Array of objects (Self) non-empty

Related links.

Array (non-empty)
href
required
string

Link URL.

rel
required
string

Type of link.

Value: "self"
401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

404

Resource not found.

get/users/{id}
Request samples
$user = $client->users()->load('userId');
Response samples
application/json
{
  • "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "email": "user@example.com",
  • "firstName": "string",
  • "lastName": "string",
  • "businessPhone": "string",
  • "mobilePhone": "string",
  • "password": "pa$$word",
  • "permissions": [
    ],
  • "computedPermissions": [
    ],
  • "createdTime": "2019-08-24T14:15:22Z",
  • "updatedTime": "2019-08-24T14:15:22Z",
  • "loginTime": "2019-08-24T14:15:22Z",
  • "reportingCurrency": "string",
  • "availableCurrencies": [
    ],
  • "totpRequired": true,
  • "totpSecret": "string",
  • "totpUrl": "string",
  • "status": "active",
  • "country": "string",
  • "preferences": { },
  • "roleIds": [
    ],
  • "allowedIps": [
    ],
  • "_links": [
    ]
}