Retrieve security settings

Request

Retrieves the sign-in security settings of the organization, and the number of users who have multi-factor authentication (MFA) set up. Settings apply to the current environment only: live and sandbox are configured separately.

Security
SecretApiKey or JWT
curl -i -X GET \
  https://www.rebilly.com/_mock/catalog/all/security-settings \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'

Responses

Security settings retrieved.
Bodyapplication/json
requireMfabooleanrequired

Specifies if users must pass multi-factor authentication (MFA) to use this organization in the Rebilly UI.

Default:false
mfaAdoptionobject or nullread-only

Number of users who have set up multi-factor authentication (MFA), excluding Rebilly staff. Pending invitations are counted as users without MFA. This value is null when this information is temporarily unavailable.

_linksArray of objects(SelfLink)read-only
Related links.
Response
{
  "requireMfa": false,
  "mfaAdoption": {
    "enrolled": 0,
    "total": 0,
    "pending": 0
  },
  "_links": [
    { … }
  ]
}