Microsoft Graph Authentication Method Configurations

Microsoft Graph Authentication Method Configurations provide programmatic control over which sign-in and multifactor authentication methods are available in Microsoft Entra ID (formerly Azure AD), how they’re configured, and who they apply to.

OpenAPI Specification

authenticationmethodconfigurations-openapi-original.yml Raw ↑
openapi: 3.1.0
info:
  title: Microsoft Graph Authenticationmethodconfigurations
  description: Needs a description.
paths:
  /authenticationMethodConfigurations:
    description: >-
      Provides operations to manage the collection of
      authenticationMethodConfiguration entities.
    get:
      tags:
        - authenticationMethodConfigurations.authenticationMethodConfiguration
      summary: Microsoft Graph Get entities from authenticationMethodConfigurations
      operationId: >-
        authenticationMethodConfigurations.authenticationMethodConfiguration.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
        4XX:
          $ref: '#/components/responses/error'
        5XX:
          $ref: '#/components/responses/error'
      x-ms-pageable:
        nextLinkName: '@odata.nextLink'
        operationName: listMore
      x-ms-docs-operation-type: operation
    post:
      tags:
        - authenticationMethodConfigurations.authenticationMethodConfiguration
      summary: Microsoft Graph Add new entity to authenticationMethodConfigurations
      operationId: >-
        authenticationMethodConfigurations.authenticationMethodConfiguration.CreateAuthenticationMethodConfiguration
      requestBody:
        description: New entity
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/microsoft.graph.authenticationMethodConfiguration
        required: true
      responses:
        2XX:
          description: Created entity
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/microsoft.graph.authenticationMethodConfiguration
        4XX:
          $ref: '#/components/responses/error'
        5XX:
          $ref: '#/components/responses/error'
      x-ms-docs-operation-type: operation
  /authenticationMethodConfigurations/{authenticationMethodConfiguration-id}:
    description: >-
      Provides operations to manage the collection of
      authenticationMethodConfiguration entities.
    get:
      tags:
        - authenticationMethodConfigurations.authenticationMethodConfiguration
      summary: Microsoft Graph Get entity from authenticationMethodConfigurations by key
      operationId: >-
        authenticationMethodConfigurations.authenticationMethodConfiguration.GetAuthenticationMethodConfiguration
      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 entity
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/microsoft.graph.authenticationMethodConfiguration
        4XX:
          $ref: '#/components/responses/error'
        5XX:
          $ref: '#/components/responses/error'
      x-ms-docs-operation-type: operation
    patch:
      tags:
        - authenticationMethodConfigurations.authenticationMethodConfiguration
      summary: Microsoft Graph Update entity in authenticationMethodConfigurations
      operationId: >-
        authenticationMethodConfigurations.authenticationMethodConfiguration.UpdateAuthenticationMethodConfiguration
      requestBody:
        description: New 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
        4XX:
          $ref: '#/components/responses/error'
        5XX:
          $ref: '#/components/responses/error'
      x-ms-docs-operation-type: operation
    delete:
      tags:
        - authenticationMethodConfigurations.authenticationMethodConfiguration
      summary: Microsoft Graph Delete entity from authenticationMethodConfigurations
      operationId: >-
        authenticationMethodConfigurations.authenticationMethodConfiguration.DeleteAuthenticationMethodConfiguration
      parameters:
        - name: If-Match
          in: header
          description: ETag
          schema:
            type: string
      responses:
        '204':
          description: Success
        4XX:
          $ref: '#/components/responses/error'
        5XX:
          $ref: '#/components/responses/error'
      x-ms-docs-operation-type: operation
    parameters:
      - name: authenticationMethodConfiguration-id
        in: path
        description: The unique identifier of authenticationMethodConfiguration
        required: true
        schema:
          type: string
        x-ms-docs-key-type: authenticationMethodConfiguration
  /authenticationMethodConfigurations/$count:
    description: Provides operations to count the resources in the collection.
    get:
      tags:
        - authenticationMethodConfigurations.authenticationMethodConfiguration
      summary: Microsoft Graph Get the number of the resource
      operationId: authenticationMethodConfigurations.GetCount-6d53
      parameters:
        - $ref: '#/components/parameters/search'
        - $ref: '#/components/parameters/filter'
      responses:
        2XX:
          $ref: '#/components/responses/ODataCountResponse'
        4XX:
          $ref: '#/components/responses/error'
        5XX:
          $ref: '#/components/responses/error'
  /authenticationMethodsPolicy/authenticationMethodConfigurations:
    description: >-
      Provides operations to manage the authenticationMethodConfigurations
      property of the microsoft.graph.authenticationMethodsPolicy entity.
    get:
      tags:
        - authenticationMethodsPolicy.authenticationMethodConfiguration
      summary: Microsoft Graph Get authenticationMethodConfigurations from authenticationMethodsPolicy
      description: >-
        Represents the settings for each authentication method. Automatically
        expanded on GET /policies/authenticationMethodsPolicy.
      operationId: authenticationMethodsPolicy.ListAuthenticationMethodConfigurations
      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
        4XX:
          $ref: '#/components/responses/error'
        5XX:
          $ref: '#/components/responses/error'
      x-ms-pageable:
        nextLinkName: '@odata.nextLink'
        operationName: listMore
      x-ms-docs-operation-type: operation
    post:
      tags:
        - authenticationMethodsPolicy.authenticationMethodConfiguration
      summary: >-
        Microsoft Graph Create new navigation property to authenticationMethodConfigurations for authenticationMethodsPolicy
      operationId: authenticationMethodsPolicy.CreateAuthenticationMethodConfigurations
      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
        4XX:
          $ref: '#/components/responses/error'
        5XX:
          $ref: '#/components/responses/error'
      x-ms-docs-operation-type: operation
  /authenticationMethodsPolicy/authenticationMethodConfigurations/{authenticationMethodConfiguration-id}:
    description: >-
      Provides operations to manage the authenticationMethodConfigurations
      property of the microsoft.graph.authenticationMethodsPolicy entity.
    get:
      tags:
        - authenticationMethodsPolicy.authenticationMethodConfiguration
      summary: Microsoft Graph Get authenticationMethodConfigurations from authenticationMethodsPolicy
      description: >-
        Represents the settings for each authentication method. Automatically
        expanded on GET /policies/authenticationMethodsPolicy.
      operationId: authenticationMethodsPolicy.GetAuthenticationMethodConfigurations
      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.authenticationMethodConfiguration
        4XX:
          $ref: '#/components/responses/error'
        5XX:
          $ref: '#/components/responses/error'
      x-ms-docs-operation-type: operation
    patch:
      tags:
        - authenticationMethodsPolicy.authenticationMethodConfiguration
      summary: >-
        Microsoft Graph Update the navigation property authenticationMethodConfigurations in authenticationMethodsPolicy
      operationId: authenticationMethodsPolicy.UpdateAuthenticationMethodConfigurations
      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
        4XX:
          $ref: '#/components/responses/error'
        5XX:
          $ref: '#/components/responses/error'
      x-ms-docs-operation-type: operation
    delete:
      tags:
        - authenticationMethodsPolicy.authenticationMethodConfiguration
      summary: >-
        Microsoft Graph Delete navigation property authenticationMethodConfigurations for authenticationMethodsPolicy
      operationId: authenticationMethodsPolicy.DeleteAuthenticationMethodConfigurations
      parameters:
        - name: If-Match
          in: header
          description: ETag
          schema:
            type: string
      responses:
        '204':
          description: Success
        4XX:
          $ref: '#/components/responses/error'
        5XX:
          $ref: '#/components/responses/error'
      x-ms-docs-operation-type: operation
    parameters:
      - name: authenticationMethodConfiguration-id
        in: path
        description: The unique identifier of authenticationMethodConfiguration
        required: true
        schema:
          type: string
        x-ms-docs-key-type: authenticationMethodConfiguration
  /authenticationMethodsPolicy/authenticationMethodConfigurations/$count:
    description: Provides operations to count the resources in the collection.
    get:
      tags:
        - authenticationMethodsPolicy.authenticationMethodConfiguration
      summary: Microsoft Graph Get the number of the resource
      operationId: >-
        authenticationMethodsPolicy.authenticationMethodConfigurations.GetCount-e7d5
      parameters:
        - $ref: '#/components/parameters/search'
        - $ref: '#/components/parameters/filter'
      responses:
        2XX:
          $ref: '#/components/responses/ODataCountResponse'
        4XX:
          $ref: '#/components/responses/error'
        5XX:
          $ref: '#/components/responses/error'
  /policies/authenticationMethodsPolicy/authenticationMethodConfigurations:
    description: >-
      Provides operations to manage the authenticationMethodConfigurations
      property of the microsoft.graph.authenticationMethodsPolicy entity.
    get:
      tags:
        - policies.authenticationMethodsPolicy
      summary: Microsoft Graph Get authenticationMethodConfigurations from policies
      description: >-
        Represents the settings for each authentication method. Automatically
        expanded on GET /policies/authenticationMethodsPolicy.
      operationId: >-
        policies.authenticationMethodsPolicy.ListAuthenticationMethodConfigurations
      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
        4XX:
          $ref: '#/components/responses/error'
        5XX:
          $ref: '#/components/responses/error'
      x-ms-pageable:
        nextLinkName: '@odata.nextLink'
        operationName: listMore
      x-ms-docs-operation-type: operation
    post:
      tags:
        - policies.authenticationMethodsPolicy
      summary: >-
        Microsoft Graph Create new navigation property to authenticationMethodConfigurations for policies
      operationId: >-
        policies.authenticationMethodsPolicy.CreateAuthenticationMethodConfigurations
      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
        4XX:
          $ref: '#/components/responses/error'
        5XX:
          $ref: '#/components/responses/error'
      x-ms-docs-operation-type: operation
  /policies/authenticationMethodsPolicy/authenticationMethodConfigurations/{authenticationMethodConfiguration-id}:
    description: >-
      Provides operations to manage the authenticationMethodConfigurations
      property of the microsoft.graph.authenticationMethodsPolicy entity.
    get:
      tags:
        - policies.authenticationMethodsPolicy
      summary: Microsoft Graph Get authenticationMethodConfigurations from policies
      description: >-
        Represents the settings for each authentication method. Automatically
        expanded on GET /policies/authenticationMethodsPolicy.
      operationId: >-
        policies.authenticationMethodsPolicy.GetAuthenticationMethodConfigurations
      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.authenticationMethodConfiguration
        4XX:
          $ref: '#/components/responses/error'
        5XX:
          $ref: '#/components/responses/error'
      x-ms-docs-operation-type: operation
    patch:
      tags:
        - policies.authenticationMethodsPolicy
      summary: >-
        Microsoft Graph Update the navigation property authenticationMethodConfigurations in policies
      operationId: >-
        policies.authenticationMethodsPolicy.UpdateAuthenticationMethodConfigurations
      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
        4XX:
          $ref: '#/components/responses/error'
        5XX:
          $ref: '#/components/responses/error'
      x-ms-docs-operation-type: operation
    delete:
      tags:
        - policies.authenticationMethodsPolicy
      summary: >-
        Microsoft Graph Delete navigation property authenticationMethodConfigurations for policies
      operationId: >-
        policies.authenticationMethodsPolicy.DeleteAuthenticationMethodConfigurations
      parameters:
        - name: If-Match
          in: header
          description: ETag
          schema:
            type: string
      responses:
        '204':
          description: Success
        4XX:
          $ref: '#/components/responses/error'
        5XX:
          $ref: '#/components/responses/error'
      x-ms-docs-operation-type: operation
    parameters:
      - name: authenticationMethodConfiguration-id
        in: path
        description: The unique identifier of authenticationMethodConfiguration
        required: true
        schema:
          type: string
        x-ms-docs-key-type: authenticationMethodConfiguration
  /policies/authenticationMethodsPolicy/authenticationMethodConfigurations/$count:
    description: Provides operations to count the resources in the collection.
    get:
      tags:
        - policies.authenticationMethodsPolicy
      summary: Microsoft Graph Get the number of the resource
      operationId: >-
        policies.authenticationMethodsPolicy.authenticationMethodConfigurations.GetCount-e541
      parameters:
        - $ref: '#/components/parameters/search'
        - $ref: '#/components/parameters/filter'
      responses:
        2XX:
          $ref: '#/components/responses/ODataCountResponse'
        4XX:
          $ref: '#/components/responses/error'
        5XX:
          $ref: '#/components/responses/error'
components:
  schemas: {}
  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
    search:
      name: $search
      in: query
      description: Search items by search phrases
      style: form
      explode: false
      schema:
        type: string
    filter:
      name: $filter
      in: query
      description: Filter items by property values
      style: form
      explode: false
      schema:
        type: string
    count:
      name: $count
      in: query
      description: Include count of items
      style: form
      explode: false
      schema:
        type: boolean
  examples: {}
  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'
tags:
  - name: authenticationMethodConfigurations.authenticationMethodConfiguration
  - name: authenticationMethodsPolicy.authenticationMethodConfiguration
  - name: policies.authenticationMethodsPolicy