GuidesAPI Reference
API Reference
  1. Authentication API v1.1
  2. Multi-factor Authentication

Enforce multi-factor authentication for a realm

put
https://account.api.here.com/authentication/v1.1/realms//forceMfa

Enable or disable enforcement of multi-factor authentication for the realm. Once enforced, all password type users who have not previously enabled MFA for their individual account will be asked to configure MFA on their next login.
Once disabled, new users will not be forced to configure MFA. Existing MFA configuration for the users will remain unchanged.


Access Control:

  • The calling principal must have "manageMfa" action permission for the resource "{realm}" in the "account" service.
  • The calling principal MUST NOT include a project scope.
Path Params
string
required

HRN of the realm, or "me". If "me" the "rlm" claim from the access token is used.

Body Params
boolean
required

Indicates whether or not multi-factor authentication is enforced on the users in this realm.

Headers
string

The unique for the request, used to track this request within the service. X-Request-ID value is NOT propagated to the downstream services.

string

Correlates HTTP requests between a client and server. If not present in the incoming request, it will be generated. This header and value will be included in all loglines including access logs. It will also be propagated to downstream services and returned in the response.

Responses

Updated last month

Did this page help you?
Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated last month

Did this page help you?