Retrieve a list of users

Request

Retrieves a list of users. To retrieve the users of the organization who have multi-factor authentication (MFA) set up, use filter=mfaEnabled:true. To retrieve the users who do not have MFA set up, including users who have not accepted their invitation, use filter=mfaEnabled:false. The mfaEnabled filter applies only to the list of users of an organization that has security settings. Inactive users and Rebilly staff are not part of the mfaEnabled filter. User objects of Rebilly staff do not include mfaEnabled. The totals are the same as those returned by the Retrieve security settings operation. If the MFA status is temporarily unavailable, the response is 503 and error is mfa_status_unavailable.

To retrieve users of the organization who can sign in only from allowed IP addresses, with allowedIps configured for the user or one of their roles, use filter=hasAllowedIps:true. To retrieve users who have no allowedIps configured for the user or any of their roles, use filter=hasAllowedIps:false. The hasAllowedIps filter applies only when listing users of an organization. It does not include allowed IP addresses configured in the security settings. Inactive users are excluded from the hasAllowedIps filter.

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

Limit the number of collection items to be returned. Use 0 to return an empty collection and still receive the count of matching items in Pagination-Total.

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=0&offset=0&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 that match the request. The value is independent of limit, including when limit is 0.

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" ]
computedAllowedIpsArray of strings or null, (ip)read-only

IP addresses specified in allowedIps for the user, the roles assigned to the user, and any roles included in those roles. This value is null if no allowed IP addresses are configured for any of them. This value is also null when a Rebilly admin retrieves their own user.

mfaEnabledboolean or nullread-only

Specifies if the user has multi-factor authentication (MFA) set up. This field is included in Retrieve a user responses for users in the current organization, and in Retrieve a list of users responses only when the organization requires MFA. This field is omitted for Rebilly staff. This value is null when this information is temporarily unavailable.

]
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": [ … ], "computedAllowedIps": [ … ], "mfaEnabled": true, "_links": [ … ] } ]