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.
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.
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.
- Mock serverhttps://www.rebilly.com/_mock/catalog/all/users
- Sandbox serverhttps://api-sandbox.rebilly.com/organizations/{organizationId}/users
- Live serverhttps://api.rebilly.com/organizations/{organizationId}/users
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'Total number of items that match the request. The value is independent of limit, including when limit is 0.
[ "PostFile", "StorefrontGetAccount", "StorefrontGetWebsite", "StorefrontGetKycDocument", "StorefrontPostKycDocument" ]
[ "PostFile", "StorefrontGetAccount", "StorefrontGetWebsite", "StorefrontGetKycDocument", "StorefrontPostKycDocument" ]
User's country of residence in ISO 3166 alpha-2 country code. For examples, see ISO.org.
List of IP addresses that are permitted access. Private subnets are prohibited. To remove restrictions, set this value to null.
[ "153.12.32.33", "201.54.122.0/24", "2001:0db8:abcd:0012:0000:0000:0000:ffff", "2001:db8:abcd:12::0/64" ]
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.
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.
[ { "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": [ … ] } ]