Edit

Share via

smsAuthenticationMethodConfiguration 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 Text Message 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 smsAuthenticationMethodConfiguration Read the properties and relationships of a smsAuthenticationMethodConfiguration object.
Update None Update the properties of a smsAuthenticationMethodConfiguration object.
Delete None Reverts the smsAuthenticationMethodConfiguration 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.
state authenticationMethodState Possible values are: enabled, disabled.

Relationships

Relationship Type Description
includeTargets smsAuthenticationMethodTarget collection A collection of groups that are enabled to use the authentication method.

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.smsAuthenticationMethodConfiguration",
  "id": "String (identifier)",
  "state": "String",
  "excludeTargets": [
    {
      "@odata.type": "microsoft.graph.excludeTarget"
    }
  ]
}