Update security settings

Request

Updates the sign-in security settings of the organization. If requireMfa is true, every user who signs in to the Rebilly UI must pass multi-factor authentication (MFA). If the session of a user has not passed MFA, other operations respond with 403 and error is mfa_required. Only owners and administrators who are signed in to the Rebilly UI can change this setting. This setting does not apply to API keys, and a request that uses an API key cannot change this setting. To turn on requireMfa, the session must have passed MFA. If the session has not passed MFA, the response is 403 and error is mfa_required_for_caller. If the number of users who have MFA set up is temporarily unavailable, requireMfa cannot be turned on and the response is 503. Settings apply to the current environment only: live and sandbox are configured separately.

Security
JWT
Bodyapplication/jsonrequired
requireMfabooleanrequired

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

Default:false
curl -i -X PUT \
  https://www.rebilly.com/_mock/catalog/all/security-settings \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "requireMfa": false
  }'

Responses

Security settings updated.
Headers
Rate-Limit-Limitinteger

Maximum number of requests available at one time for this rate limit. For more information, see Rate limits.

Example:500
Rate-Limit-Remaininginteger

Number of requests still available for this rate limit. For more information, see Rate limits.

Example:499
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": [
    { … }
  ]
}