Microsoft Entra ID (formerly Azure AD)

Microsoft Entra ID (formerly Azure AD) Policies.authentication Methods Policy API

The policies.authenticationMethodsPolicy API from Microsoft Entra ID (formerly Azure AD) — 4 operation(s) for policies.authenticationmethodspolicy.

GitHub OpenAPI
Business capability
Identity & Access Management BC-620.20

Operations 9

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /policies/authenticationMethodsPolicy Get the tenant authentication methods policy · Get authenticationMethodsPolicy #
Ask an LLM
“Which authentication methods are enabled for users in my tenant?”
“How do I check the registration enforcement and migration state of the authentication methods policy?”
Tell an agent
Show the tenant's authentication methods policy.
Get the authentication methods policy with its method configurations.
PATCH /policies/authenticationMethodsPolicy Update the authentication methods policy · Update authenticationMethodsPolicy #
Ask an LLM
“How do I change how often users must reconfirm their authentication methods?”
“Can I move the tenant's policy migration state forward from legacy MFA settings?”
Tell an agent
Set authentication method reconfirmation to every {reconfirmationInDays} days.
Change the authentication methods policy migration state to {policyMigrationState}.
DELETE /policies/authenticationMethodsPolicy Delete the authentication methods policy · Delete navigation property authenticationMethodsPolicy for policies #
Ask an LLM
“Can I delete the authentication methods policy object entirely?”
“What call removes the authenticationMethodsPolicy navigation property?”
Tell an agent destructive · confirm first
Delete the tenant's authentication methods policy.
Remove the authenticationMethodsPolicy from policies.
GET /policies/authenticationMethodsPolicy/authenticationMethodConfigurations List authentication method configurations · Get externalAuthenticationMethodConfiguration #
Ask an LLM
“What's the configuration of each authentication method, like FIDO2 or SMS, in my tenant?”
“How do I see all external and built-in authentication method configurations?”
Tell an agent
List all authentication method configurations.
Show authentication method configurations matching {filter}.
POST /policies/authenticationMethodsPolicy/authenticationMethodConfigurations Add an authentication method configuration · Create new navigation property to authenticationMethodConfigurations for… #
Ask an LLM
“How do I add a new external authentication method configuration to the policy?”
“Can I create a method configuration that starts disabled?”
Tell an agent
Create an authentication method configuration with state {state}.
Add a method configuration excluding {excludeTargets}.
GET /policies/authenticationMethodsPolicy/authenticationMethodConfigurations/{authenticationMethodConfiguration-id} Get one authentication method configuration · Get externalAuthenticationMethodConfiguration #
Ask an LLM
“Is a specific authentication method enabled, and who is excluded from it?”
“How do I read one external authentication method configuration by ID?”
Tell an agent
Get authentication method configuration {method}.
Show whether method {method} is enabled and who it excludes.
PATCH /policies/authenticationMethodsPolicy/authenticationMethodConfigurations/{authenticationMethodConfiguration-id} Enable, disable or scope an authentication method · Update externalAuthenticationMethodConfiguration #
Ask an LLM
“How do I disable a specific authentication method for the whole tenant?”
“Can I exclude a group from using an authentication method?”
Tell an agent
Set authentication method {method} to {state}.
Exclude {excludeTargets} from authentication method {method}.
DELETE /policies/authenticationMethodsPolicy/authenticationMethodConfigurations/{authenticationMethodConfiguration-id} Delete an authentication method configuration · Delete externalAuthenticationMethodConfiguration #
Ask an LLM
“How do I remove an external authentication method from my tenant?”
“Can I delete one authentication method configuration by ID?”
Tell an agent destructive · confirm first
Delete authentication method configuration {method}.
Remove external authentication method {method}.
GET /policies/authenticationMethodsPolicy/authenticationMethodConfigurations/$count Count authentication method configurations · Get the number of the resource #
Ask an LLM
“How many authentication method configurations does my tenant have?”
“What's the number of method configurations in the authentication methods policy?”
Tell an agent
Count the authentication method configurations.
Tell me how many methods are configured in the methods policy.

Documentation

📖
Documentation
https://learn.microsoft.com/en-us/graph/api/overview
📖
Authentication
https://learn.microsoft.com/en-us/graph/auth/
📖
Documentation
https://learn.microsoft.com/en-us/graph/change-notifications-overview

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/azure-ad/refs/heads/main/openapi/azure-ad-policies-authenticationmethodspolicy-api-openapi.yml

Other Resources

🔗
SDKs
https://learn.microsoft.com/en-us/graph/sdks/sdks-overview
🔗
ChangeLog
https://developer.microsoft.com/en-us/graph/changelog
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/azure-ad/refs/heads/main/asyncapi/azure-ad-change-notifications-webhooks.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/azure-ad:azure-ad-policies-authenticationmethodspolicy-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

azure-ad-policies-authenticationmethodspolicy-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Identity.SignIns Policies.authentication Methods Policy API
  version: v1.0
servers:
- url: https://graph.microsoft.com/v1.0/
  description: Core
security:
- azureaadv2: []
tags:
- name: policies.authenticationMethodsPolicy
paths:
  /policies/authenticationMethodsPolicy:
    get:
      tags:
      - policies.authenticationMethodsPolicy
      summary: Get authenticationMethodsPolicy
      description: Read the properties and relationships of an authenticationMethodsPolicy object.
      externalDocs:
        description: Find more info here
        url: https://learn.microsoft.com/graph/api/authenticationmethodspolicy-get?view=graph-rest-1.0
      operationId: policy_GetAuthenticationMethodsPolicy
      parameters:
      - name: $select
        in: query
        description: Select properties to be returned
        style: form
        explode: false
        schema:
          uniqueItems: true
          type: array
          items:
            type: string
      - name: $expand
        in: query
        description: Expand related entities
        style: form
        explode: false
        schema:
          uniqueItems: true
          type: array
          items:
            type: string
      responses:
        2XX:
          description: Retrieved navigation property
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/microsoft.graph.authenticationMethodsPolicy'
        default:
          $ref: '#/components/responses/error'
      x-ms-docs-operation-type: operation
    patch:
      tags:
      - policies.authenticationMethodsPolicy
      summary: Update authenticationMethodsPolicy
      description: Update the properties of an authenticationMethodsPolicy object.
      externalDocs:
        description: Find more info here
        url: https://learn.microsoft.com/graph/api/authenticationmethodspolicy-update?view=graph-rest-1.0
      operationId: policy_UpdateAuthenticationMethodsPolicy
      requestBody:
        description: New navigation property values
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/microsoft.graph.authenticationMethodsPolicy'
        required: true
      responses:
        2XX:
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/microsoft.graph.authenticationMethodsPolicy'
        default:
          $ref: '#/components/responses/error'
      x-ms-docs-operation-type: operation
    delete:
      tags:
      - policies.authenticationMethodsPolicy
      summary: Delete navigation property authenticationMethodsPolicy for policies
      operationId: policy_DeleteAuthenticationMethodsPolicy
      parameters:
      - name: If-Match
        in: header
        description: ETag
        style: simple
        schema:
          type: string
      responses:
        2XX:
          description: Success
        default:
          $ref: '#/components/responses/error'
      x-ms-docs-operation-type: operation
  /policies/authenticationMethodsPolicy/authenticationMethodConfigurations:
    get:
      tags:
      - policies.authenticationMethodsPolicy
      summary: Get externalAuthenticationMethodConfiguration
      description: Read the properties and relationships of an externalAuthenticationMethodConfiguration object.
      operationId: policy.authenticationMethodsPolicy_ListAuthenticationMethodConfiguration
      parameters:
      - $ref: '#/components/parameters/top'
      - $ref: '#/components/parameters/skip'
      - $ref: '#/components/parameters/search'
      - $ref: '#/components/parameters/filter'
      - $ref: '#/components/parameters/count'
      - name: $orderby
        in: query
        description: Order items by property values
        style: form
        explode: false
        schema:
          uniqueItems: true
          type: array
          items:
            type: string
      - name: $select
        in: query
        description: Select properties to be returned
        style: form
        explode: false
        schema:
          uniqueItems: true
          type: array
          items:
            type: string
      - name: $expand
        in: query
        description: Expand related entities
        style: form
        explode: false
        schema:
          uniqueItems: true
          type: array
          items:
            type: string
      responses:
        2XX:
          $ref: '#/components/responses/microsoft.graph.authenticationMethodConfigurationCollectionResponse'
        default:
          $ref: '#/components/responses/error'
      x-ms-pageable:
        nextLinkName: '@odata.nextLink'
        operationName: listMore
      x-ms-docs-operation-type: operation
    post:
      tags:
      - policies.authenticationMethodsPolicy
      summary: Create new navigation property to authenticationMethodConfigurations for…
      operationId: policy.authenticationMethodsPolicy_CreateAuthenticationMethodConfiguration
      requestBody:
        description: New navigation property
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/microsoft.graph.authenticationMethodConfiguration'
        required: true
      responses:
        2XX:
          description: Created navigation property.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/microsoft.graph.authenticationMethodConfiguration'
        default:
          $ref: '#/components/responses/error'
      x-ms-docs-operation-type: operation
  /policies/authenticationMethodsPolicy/authenticationMethodConfigurations/{authenticationMethodConfiguration-id}:
    get:
      tags:
      - policies.authenticationMethodsPolicy
      summary: Get externalAuthenticationMethodConfiguration
      description: Read the properties and relationships of an externalAuthenticationMethodConfiguration object.
      externalDocs:
        description: Find more info here
        url: https://learn.microsoft.com/graph/api/externalauthenticationmethodconfiguration-get?view=graph-rest-1.0
      operationId: policy.authenticationMethodsPolicy_GetAuthenticationMethodConfiguration
      parameters:
      - name: authenticationMethodConfiguration-id
        in: path
        description: The unique identifier of authenticationMethodConfiguration
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: authenticationMethodConfiguration
      - name: $select
        in: query
        description: Select properties to be returned
        style: form
        explode: false
        schema:
          uniqueItems: true
          type: array
          items:
            type: string
      - name: $expand
        in: query
        description: Expand related entities
        style: form
        explode: false
        schema:
          uniqueItems: true
          type: array
          items:
            type: string
      responses:
        2XX:
          description: Retrieved navigation property
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/microsoft.graph.authenticationMethodConfiguration'
        default:
          $ref: '#/components/responses/error'
      x-ms-docs-operation-type: operation
    patch:
      tags:
      - policies.authenticationMethodsPolicy
      summary: Update externalAuthenticationMethodConfiguration
      description: Update the properties of an externalAuthenticationMethodConfiguration object.
      externalDocs:
        description: Find more info here
        url: https://learn.microsoft.com/graph/api/externalauthenticationmethodconfiguration-update?view=graph-rest-1.0
      operationId: policy.authenticationMethodsPolicy_UpdateAuthenticationMethodConfiguration
      parameters:
      - name: authenticationMethodConfiguration-id
        in: path
        description: The unique identifier of authenticationMethodConfiguration
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: authenticationMethodConfiguration
      requestBody:
        description: New navigation property values
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/microsoft.graph.authenticationMethodConfiguration'
        required: true
      responses:
        2XX:
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/microsoft.graph.authenticationMethodConfiguration'
        default:
          $ref: '#/components/responses/error'
      x-ms-docs-operation-type: operation
    delete:
      tags:
      - policies.authenticationMethodsPolicy
      summary: Delete externalAuthenticationMethodConfiguration
      description: Delete an externalAuthenticationMethodConfiguration object.
      externalDocs:
        description: Find more info here
        url: https://learn.microsoft.com/graph/api/externalauthenticationmethodconfiguration-delete?view=graph-rest-1.0
      operationId: policy.authenticationMethodsPolicy_DeleteAuthenticationMethodConfiguration
      parameters:
      - name: authenticationMethodConfiguration-id
        in: path
        description: The unique identifier of authenticationMethodConfiguration
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: authenticationMethodConfiguration
      - name: If-Match
        in: header
        description: ETag
        style: simple
        schema:
          type: string
      responses:
        2XX:
          description: Success
        default:
          $ref: '#/components/responses/error'
      x-ms-docs-operation-type: operation
  /policies/authenticationMethodsPolicy/authenticationMethodConfigurations/$count:
    get:
      tags:
      - policies.authenticationMethodsPolicy
      summary: Get the number of the resource
      operationId: policy.authenticationMethodsPolicy.authenticationMethodConfiguration_GetCount
      parameters:
      - $ref: '#/components/parameters/search'
      - $ref: '#/components/parameters/filter'
      responses:
        2XX:
          $ref: '#/components/responses/ODataCountResponse'
        default:
          $ref: '#/components/responses/error'
components:
  responses:
    error:
      description: error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/microsoft.graph.ODataErrors.ODataError'
    ODataCountResponse:
      description: The count of the resource
      content:
        text/plain:
          schema:
            $ref: '#/components/schemas/ODataCountResponse'
    microsoft.graph.authenticationMethodConfigurationCollectionResponse:
      description: Retrieved collection
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/microsoft.graph.authenticationMethodConfigurationCollectionResponse'
  schemas:
    microsoft.graph.ODataErrors.InnerError:
      type: object
      additionalProperties:
        type: object
      description: The structure of this object is service-specific
    microsoft.graph.excludeTarget:
      title: excludeTarget
      type: object
      properties:
        id:
          type: string
          description: The object identifier of a Microsoft Entra user or group.
        targetType:
          $ref: '#/components/schemas/microsoft.graph.authenticationMethodTargetType'
      additionalProperties:
        type: object
    microsoft.graph.ODataErrors.MainError:
      required:
      - code
      - message
      type: object
      properties:
        code:
          type: string
        message:
          type: string
          x-ms-primary-error-message: true
        target:
          type:
          - string
          - 'null'
        details:
          type: array
          items:
            $ref: '#/components/schemas/microsoft.graph.ODataErrors.ErrorDetails'
        innerError:
          $ref: '#/components/schemas/microsoft.graph.ODataErrors.InnerError'
      additionalProperties:
        type: object
    microsoft.graph.authenticationMethodsRegistrationCampaignIncludeTarget:
      title: authenticationMethodsRegistrationCampaignIncludeTarget
      type: object
      properties:
        id:
          type: string
          description: The object identifier of a Microsoft Entra user or group.
        targetedAuthenticationMethod:
          type:
          - string
          - 'null'
          description: The authentication method that the user is prompted to register. The value can be Fido2 or microsoftAuthenticator.
        targetType:
          $ref: '#/components/schemas/microsoft.graph.authenticationMethodTargetType'
      additionalProperties:
        type: object
    microsoft.graph.authenticationMethodConfigurationCollectionResponse:
      title: Collection of authenticationMethodConfiguration
      type: object
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/microsoft.graph.authenticationMethodConfiguration'
        '@odata.nextLink':
          type:
          - string
          - 'null'
      additionalProperties:
        type: object
    microsoft.graph.authenticationMethodTargetType:
      title: authenticationMethodTargetType
      enum:
      - user
      - group
      - unknownFutureValue
      type: string
    microsoft.graph.authenticationMethodConfiguration:
      allOf:
      - $ref: '#/components/schemas/microsoft.graph.entity'
      - title: authenticationMethodConfiguration
        type: object
        properties:
          excludeTargets:
            type: array
            items:
              $ref: '#/components/schemas/microsoft.graph.excludeTarget'
            description: Groups of users that are excluded from a policy.
          state:
            $ref: '#/components/schemas/microsoft.graph.authenticationMethodState'
        additionalProperties:
          type: object
    microsoft.graph.authenticationMethodsRegistrationCampaign:
      title: authenticationMethodsRegistrationCampaign
      type: object
      properties:
        excludeTargets:
          type: array
          items:
            $ref: '#/components/schemas/microsoft.graph.excludeTarget'
          description: Users and groups of users that are excluded from being prompted to set up the authentication method.
        includeTargets:
          type: array
          items:
            $ref: '#/components/schemas/microsoft.graph.authenticationMethodsRegistrationCampaignIncludeTarget'
          description: Users and groups of users that are prompted to set up the authentication method.
        snoozeDurationInDays:
          maximum: 2147483647
          minimum: -2147483648
          type: number
          description: 'Specifies the number of days that the user sees a prompt again if they select ''Not now'' and snoozes the prompt. Minimum: 0 days. Maximum: 14 days. If the value is ''0'', the user is prompted during every MFA attempt.'
          format: int32
        state:
          $ref: '#/components/schemas/microsoft.graph.advancedConfigState'
      additionalProperties:
        type: object
    microsoft.graph.authenticationMethodState:
      title: authenticationMethodState
      enum:
      - enabled
      - disabled
      type: string
    microsoft.graph.advancedConfigState:
      title: advancedConfigState
      enum:
      - default
      - enabled
      - disabled
      - unknownFutureValue
      type: string
    microsoft.graph.registrationEnforcement:
      title: registrationEnforcement
      type: object
      properties:
        authenticationMethodsRegistrationCampaign:
          $ref: '#/components/schemas/microsoft.graph.authenticationMethodsRegistrationCampaign'
      additionalProperties:
        type: object
    microsoft.graph.ODataErrors.ODataError:
      required:
      - error
      type: object
      properties:
        error:
          $ref: '#/components/schemas/microsoft.graph.ODataErrors.MainError'
      additionalProperties:
        type: object
    microsoft.graph.ODataErrors.ErrorDetails:
      required:
      - code
      - message
      type: object
      properties:
        code:
          type: string
        message:
          type: string
        target:
          type:
          - string
          - 'null'
      additionalProperties:
        type: object
    microsoft.graph.entity:
      title: entity
      type: object
      properties:
        id:
          type: string
          description: The unique identifier for an entity. Read-only.
      additionalProperties:
        type: object
    microsoft.graph.authenticationMethodsPolicyMigrationState:
      title: authenticationMethodsPolicyMigrationState
      enum:
      - preMigration
      - migrationInProgress
      - migrationComplete
      - unknownFutureValue
      type: string
    ODataCountResponse:
      type: integer
      format: int32
    microsoft.graph.authenticationMethodsPolicy:
      allOf:
      - $ref: '#/components/schemas/microsoft.graph.entity'
      - title: authenticationMethodsPolicy
        type: object
        properties:
          description:
            type:
            - string
            - 'null'
            description: A description of the policy. Read-only.
          displayName:
            type:
            - string
            - 'null'
            description: The name of the policy. Read-only.
          lastModifiedDateTime:
            pattern: ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$
            type:
            - string
            - 'null'
            description: The date and time of the last update to the policy. Read-only.
            format: date-time
          policyMigrationState:
            $ref: '#/components/schemas/microsoft.graph.authenticationMethodsPolicyMigrationState'
          policyVersion:
            type:
            - string
            - 'null'
            description: The version of the policy in use. Read-only.
          reconfirmationInDays:
            maximum: 2147483647
            minimum: -2147483648
            type:
            - number
            - 'null'
            format: int32
          registrationEnforcement:
            $ref: '#/components/schemas/microsoft.graph.registrationEnforcement'
          authenticationMethodConfigurations:
            type: array
            items:
              $ref: '#/components/schemas/microsoft.graph.authenticationMethodConfiguration'
            description: Represents the settings for each authentication method. Automatically expanded on GET /policies/authenticationMethodsPolicy.
            x-ms-navigationProperty: true
        additionalProperties:
          type: object
  parameters:
    top:
      name: $top
      in: query
      description: Show only the first n items
      style: form
      explode: false
      schema:
        minimum: 0
        type: integer
      example: 50
    skip:
      name: $skip
      in: query
      description: Skip the first n items
      style: form
      explode: false
      schema:
        minimum: 0
        type: integer
    filter:
      name: $filter
      in: query
      description: Filter items by property values
      style: form
      explode: false
      schema:
        type: string
    search:
      name: $search
      in: query
      description: Search items by search phrases
      style: form
      explode: false
      schema:
        type: string
    count:
      name: $count
      in: query
      description: Include count of items
      style: form
      explode: false
      schema:
        type: boolean
  securitySchemes:
    azureaadv2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
          tokenUrl: https://login.microsoftonline.com/common/oauth2/v2.0/token
          scopes: {}