Microsoft Graph Authentication Methods Policies

openapi: 3.1.0
info:
  title: Microsoft Graph Authenticationmethodspolicy
  description: Needs a description.
paths:
  /authenticationMethodsPolicy:
    description: Provides operations to manage the authenticationMethodsPolicy singleton.
    get:
      tags:
        - authenticationMethodsPolicy.authenticationMethodsPolicy
      summary: Microsoft Graph Get authenticationMethodsPolicy
      operationId: >-
        authenticationMethodsPolicy.authenticationMethodsPolicy.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 entity
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/microsoft.graph.authenticationMethodsPolicy
        4XX:
          $ref: '#/components/responses/error'
        5XX:
          $ref: '#/components/responses/error'
      x-ms-docs-operation-type: operation
    patch:
      tags:
        - authenticationMethodsPolicy.authenticationMethodsPolicy
      summary: Microsoft Graph Update authenticationMethodsPolicy
      operationId: >-
        authenticationMethodsPolicy.authenticationMethodsPolicy.UpdateAuthenticationMethodsPolicy
      requestBody:
        description: New 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
        4XX:
          $ref: '#/components/responses/error'
        5XX:
          $ref: '#/components/responses/error'
      x-ms-docs-operation-type: operation
  /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:
    description: >-
      Provides operations to manage the authenticationMethodsPolicy property of
      the microsoft.graph.policyRoot entity.
    get:
      tags:
        - policies.authenticationMethodsPolicy
      summary: Microsoft Graph 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: policies.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
        4XX:
          $ref: '#/components/responses/error'
        5XX:
          $ref: '#/components/responses/error'
      x-ms-docs-operation-type: operation
    patch:
      tags:
        - policies.authenticationMethodsPolicy
      summary: Microsoft Graph 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: policies.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
        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 authenticationMethodsPolicy for policies
      operationId: policies.DeleteAuthenticationMethodsPolicy
      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
  /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:
    microsoft.graph.authenticationMethodsPolicy:
      allOf:
        - $ref: '#/components/schemas/microsoft.graph.entity'
        - title: authenticationMethodsPolicy
          required:
            - '@odata.type'
          type: object
          properties:
            description:
              type: string
              description: A description of the policy. Read-only.
              nullable: true
            displayName:
              type: string
              description: The name of the policy. Read-only.
              nullable: true
            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
              description: The date and time of the last update to the policy. Read-only.
              format: date-time
              nullable: true
            policyMigrationState:
              anyOf:
                - $ref: >-
                    #/components/schemas/microsoft.graph.authenticationMethodsPolicyMigrationState
                - type: object
                  nullable: true
              description: >-
                The state of migration of the authentication methods policy from
                the legacy multifactor authentication and self-service password
                reset (SSPR) policies. The possible values are: premigration -
                means the authentication methods policy is used for
                authentication only, legacy policies are respected.
                migrationInProgress - means the authentication methods policy is
                used for both authentication and SSPR, legacy policies are
                respected. migrationComplete - means the authentication methods
                policy is used for authentication and SSPR, legacy policies are
                ignored. unknownFutureValue - Evolvable enumeration sentinel
                value. Do not use.
            policyVersion:
              type: string
              description: The version of the policy in use. Read-only.
              nullable: true
            reconfirmationInDays:
              maximum: 2147483647
              minimum: -2147483648
              type: number
              format: int32
              nullable: true
            registrationEnforcement:
              anyOf:
                - $ref: '#/components/schemas/microsoft.graph.registrationEnforcement'
                - type: object
                  nullable: true
              description: >-
                Enforce registration at sign-in time. This property can be used
                to remind users to set up targeted authentication methods.
            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
            '@odata.type':
              type: string
      x-ms-discriminator-value: '#microsoft.graph.authenticationMethodsPolicy'
  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: authenticationMethodsPolicy.authenticationMethodConfiguration
  - name: authenticationMethodsPolicy.authenticationMethodsPolicy
  - name: policies.authenticationMethodsPolicy