Users

Use these operations to manage users. A user is a person who can login to Rebilly, and take actions based on their granted permissions.

Operations

Retrieve a list of users

Request

Retrieves a list of users.

Security
SecretApiKey or JWT
Query
limitinteger, [ 0 .. 1000 ]

Limits the number of collection items to be returned.

offsetinteger, [ 0 .. 1000 ]

Specifies the starting point within the collection of items to be returned.

sortArray of strings

Sorts and orders the collection of items. To sort in descending order, prefix with -. Multiple fields can be sorted by separating each with ,.

filterstring

Criteria for filtering collection items. This field requires a special format. Use , to specify multiple allowed values. Use ; to specify multiple fields.

For more information, see Search filters.

qstring

Use this field to perform a partial search of text fields.

curl -i -X GET \
  'https://www.rebilly.com/_mock/catalog/all/users?limit=1000&offset=1000&sort=string&filter=string&q=string' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'

Responses

List of users retrieved.

Headers
Pagination-Totalinteger

Total number of items.

Example:332
Pagination-Limitinteger

Maximum number of items per page.

Example:100
Pagination-Offsetinteger

Specifies the starting point within the collection of resource results. For example, a request with limit=20 retrieves and displays the first 20 results on a page. A following request with limit=20 and offset=20, retrieves the next page of 20 results.

Example:2
Bodyapplication/json
Array [
idstring, <= 50 charactersread-only

ID of the user.

Example:"usr_0YVCEENYJ3D7Q9EN6BN16HA0G4"
emailstring, (email), <= 80 charactersrequired

Email address of the user.

firstNamestring, [ 1 .. 45 ] charactersrequired

User's first name.

lastNamestring, [ 1 .. 45 ] charactersrequired

User's last name.

businessPhonestring or null, [ 1 .. 20 ] characters

User's business phone number.

mobilePhonestring or null, [ 1 .. 20 ] characters

User's mobile phone number.

permissionsArray of strings, (operationId)(AclPermissions)

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

Example:
[
  "PostFile",
  "StorefrontGetAccount",
  "StorefrontGetWebsite",
  "StorefrontGetKycDocument",
  "StorefrontPostKycDocument"
]
computedPermissionsArray of strings, (operationId)(AclPermissions)read-only

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

Example:
[
  "PostFile",
  "StorefrontGetAccount",
  "StorefrontGetWebsite",
  "StorefrontGetKycDocument",
  "StorefrontPostKycDocument"
]
createdTimestring, (date-time)(CreatedTime)read-only

Date and time when the resource is created. This value is set automatically when the resource is created.

updatedTimestring, (date-time)(UpdatedTime)read-only

Date and time when the resource is updated. This value is set automatically when the resource is updated.

loginTimestring or null, (date-time)read-only

Date and time when the user last logged in.

reportingCurrencystringread-only

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

availableCurrenciesArray of stringsread-only

Array of reporting currencies that are enabled for the merchant.

statusstringread-only

Status of the user's account.

Enum:"active""inactive""pending-confirmation"
countrystring

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

preferencesobject or null

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

roleIdsArray 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.

allowedIpsArray 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.

Example:
[
  "153.12.32.33",
  "201.54.122.0/24",
  "2001:0db8:abcd:0012:0000:0000:0000:ffff",
  "2001:db8:abcd:12::0/64"
]
]
Response
[
  {
    "id": "usr_0YVCEENYJ3D7Q9EN6BN16HA0G4",
    "email": "user@example.com",
    "firstName": "string",
    "lastName": "string",
    "businessPhone": "string",
    "mobilePhone": "string",
    "permissions": [ … ],
    "computedPermissions": [ … ],
    "createdTime": "2019-08-24T14:15:22Z",
    "updatedTime": "2019-08-24T14:15:22Z",
    "loginTime": "2019-08-24T14:15:22Z",
    "reportingCurrency": "string",
    "availableCurrencies": [ … ],
    "status": "active",
    "country": "string",
    "preferences": {},
    "roleIds": [ … ],
    "allowedIps": [ … ],
    "_links": [ … ]
  }
]