Edit

Share via

microsoftAuthenticatorAuthenticationMethodConfiguration resource type

  • Article

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Represents a Microsoft Authenticator authentication methods policy. Authentication methods policies define configuration settings and users or groups that are enabled to use the authentication method.

Inherits from authenticationMethodConfiguration.

Methods

Method Return type Description
Get microsoftAuthenticatorAuthenticationMethodConfiguration Read the properties and relationships of a microsoftAuthenticatorAuthenticationMethodConfiguration object.
Update None Update the properties of a microsoftAuthenticatorAuthenticationMethodConfiguration object.
Delete None Reverts the microsoftAuthenticatorAuthenticationMethodConfiguration object to its default configuration.

Properties

Property Type Description
excludeTargets excludeTarget collection Groups of users that are excluded from the policy.
id String The authentication method policy identifier.
isSoftwareOathEnabled Boolean true if users can use the OTP code generated by the Microsoft Authenticator app, false otherwise.
state authenticationMethodState Possible values are: enabled, disabled.
featureSettings microsoftAuthenticatorFeatureSettings A collection of Microsoft Authenticator settings such as number matching and location context, and whether they are enabled for all users or specific users only.

Relationships

Relationship Type Description
includeTargets microsoftAuthenticatorAuthenticationMethodTarget collection A collection of groups that are enabled to use the authentication method. Expanded by default.

The following JSON representation shows the resource type. The following is a JSON representation of the resource.

{
  "@odata.type": "#microsoft.graph.microsoftAuthenticatorAuthenticationMethodConfiguration",
  "id": "String (identifier)",
  "state": "String",
  "excludeTargets": [
    {
      "@odata.type": "microsoft.graph.excludeTarget"
    }
  ],
  "isSoftwareOathEnabled": "Boolean",
  "featureSettings": {
    "@odata.type": "microsoft.graph.microsoftAuthenticatorFeatureSettings"
  }
}