openapi: 3.1.0
info:
  title: Microsoft Graph Identityproviders
  description: Needs a description.
paths:
  ? /identity/authenticationEventsFlows/{authenticationEventsFlow-id}/graph.externalUsersSelfServiceSignUpEventsFlow/onAuthenticationMethodLoadStart/graph.onAuthenticationMethodLoadStartExternalUsersSelfServiceSignUp/identityProviders
  : description: >-
      Provides operations to manage the identityProviders property of the
      microsoft.graph.onAuthenticationMethodLoadStartExternalUsersSelfServiceSignUp
      entity.
    get:
      tags:
        - identity.authenticationEventsFlow
      summary: Microsoft Graph List identityProviders (in a user flow)
      description: >-
        Get the identity providers that are defined for an external identities
        self-service sign up user flow that's represented by an
        externalUsersSelfServiceSignupEventsFlow object type.
      externalDocs:
        description: Find more info here
        url: >-
          https://learn.microsoft.com/graph/api/onauthenticationmethodloadstartexternalusersselfservicesignup-list-identityproviders?view=graph-rest-1.0
      operationId: >-
        identity.authenticationEventsFlows.AsOnAuthenticationMethodLoadStartExternalUsersSelfServiceSignUp.ListIdentityProviders
      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.identityProviderBaseCollectionResponse
        4XX:
          $ref: '#/components/responses/error'
        5XX:
          $ref: '#/components/responses/error'
      x-ms-pageable:
        nextLinkName: '@odata.nextLink'
        operationName: listMore
      x-ms-docs-operation-type: operation
    parameters:
      - name: authenticationEventsFlow-id
        in: path
        description: The unique identifier of authenticationEventsFlow
        required: true
        schema:
          type: string
        x-ms-docs-key-type: authenticationEventsFlow
  ? /identity/authenticationEventsFlows/{authenticationEventsFlow-id}/graph.externalUsersSelfServiceSignUpEventsFlow/onAuthenticationMethodLoadStart/graph.onAuthenticationMethodLoadStartExternalUsersSelfServiceSignUp/identityProviders/{identityProviderBase-id}/$ref
  : description: >-
      Provides operations to manage the collection of identityContainer
      entities.
    delete:
      tags:
        - identity.authenticationEventsFlow
      summary: Microsoft Graph Delete ref of navigation property identityProviders for identity
      operationId: >-
        identity.authenticationEventsFlows.AsOnAuthenticationMethodLoadStartExternalUsersSelfServiceSignUp.identityProviders.DeleteRefIdentityProviderBase
      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: authenticationEventsFlow-id
        in: path
        description: The unique identifier of authenticationEventsFlow
        required: true
        schema:
          type: string
        x-ms-docs-key-type: authenticationEventsFlow
      - name: identityProviderBase-id
        in: path
        description: The unique identifier of identityProviderBase
        required: true
        schema:
          type: string
        x-ms-docs-key-type: identityProviderBase
  ? /identity/authenticationEventsFlows/{authenticationEventsFlow-id}/graph.externalUsersSelfServiceSignUpEventsFlow/onAuthenticationMethodLoadStart/graph.onAuthenticationMethodLoadStartExternalUsersSelfServiceSignUp/identityProviders/$count
  : description: Provides operations to count the resources in the collection.
    get:
      tags:
        - identity.authenticationEventsFlow
      summary: Microsoft Graph Get the number of the resource
      operationId: >-
        identity.authenticationEventsFlows.AsOnAuthenticationMethodLoadStartExternalUsersSelfServiceSignUp.identityProviders.GetCount-4765
      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'
    parameters:
      - name: authenticationEventsFlow-id
        in: path
        description: The unique identifier of authenticationEventsFlow
        required: true
        schema:
          type: string
        x-ms-docs-key-type: authenticationEventsFlow
  ? /identity/authenticationEventsFlows/{authenticationEventsFlow-id}/graph.externalUsersSelfServiceSignUpEventsFlow/onAuthenticationMethodLoadStart/graph.onAuthenticationMethodLoadStartExternalUsersSelfServiceSignUp/identityProviders/$ref
  : description: >-
      Provides operations to manage the collection of identityContainer
      entities.
    get:
      tags:
        - identity.authenticationEventsFlow
      summary: Microsoft Graph List identityProviders (in a user flow)
      description: >-
        Get the identity providers that are defined for an external identities
        self-service sign up user flow that's represented by an
        externalUsersSelfServiceSignupEventsFlow object type.
      externalDocs:
        description: Find more info here
        url: >-
          https://learn.microsoft.com/graph/api/onauthenticationmethodloadstartexternalusersselfservicesignup-list-identityproviders?view=graph-rest-1.0
      operationId: >-
        identity.authenticationEventsFlows.AsOnAuthenticationMethodLoadStartExternalUsersSelfServiceSignUp.ListRefIdentityProviders
      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
      responses:
        2XX:
          $ref: '#/components/responses/StringCollectionResponse'
        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:
        - identity.authenticationEventsFlow
      summary: Microsoft Graph Add identityProvider (to a user flow)
      description: >-
        Add an identity provider to an external identities self-service user
        flow represented by an externalUsersSelfServiceSignupEventsFlow object
        type. The identity provider must first be configured in the tenant.
      externalDocs:
        description: Find more info here
        url: >-
          https://learn.microsoft.com/graph/api/onauthenticationmethodloadstartexternalusersselfservicesignup-post-identityproviders?view=graph-rest-1.0
      operationId: >-
        identity.authenticationEventsFlows.AsOnAuthenticationMethodLoadStartExternalUsersSelfServiceSignUp.CreateRefIdentityProviders
      requestBody:
        $ref: '#/components/requestBodies/refPostBody'
      responses:
        '204':
          description: Success
        4XX:
          $ref: '#/components/responses/error'
        5XX:
          $ref: '#/components/responses/error'
      x-ms-docs-operation-type: operation
    delete:
      tags:
        - identity.authenticationEventsFlow
      summary: Microsoft Graph Delete ref of navigation property identityProviders for identity
      operationId: >-
        identity.authenticationEventsFlows.AsOnAuthenticationMethodLoadStartExternalUsersSelfServiceSignUp.DeleteRefIdentityProviders
      parameters:
        - name: If-Match
          in: header
          description: ETag
          schema:
            type: string
        - name: '@id'
          in: query
          description: The delete Uri
          required: true
          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: authenticationEventsFlow-id
        in: path
        description: The unique identifier of authenticationEventsFlow
        required: true
        schema:
          type: string
        x-ms-docs-key-type: authenticationEventsFlow
  /identity/b2xUserFlows/{b2xIdentityUserFlow-id}/identityProviders:
    description: >-
      Provides operations to manage the identityProviders property of the
      microsoft.graph.b2xIdentityUserFlow entity.
    get:
      tags:
        - identity.b2xIdentityUserFlow
      summary: Microsoft Graph List identityProviders
      description: Get the identity providers in a b2xIdentityUserFlow object.
      externalDocs:
        description: Find more info here
        url: >-
          https://learn.microsoft.com/graph/api/b2xidentityuserflow-list-identityproviders?view=graph-rest-1.0
      operationId: identity.b2xUserFlows.ListIdentityProviders
      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.identityProviderCollectionResponse
        4XX:
          $ref: '#/components/responses/error'
        5XX:
          $ref: '#/components/responses/error'
      deprecated: true
      x-ms-deprecation:
        removalDate: '2023-03-15'
        date: '2021-08-24'
        version: 2021-05/identityProvider
        description: >-
          The identityProvider API is deprecated and will stop returning data on
          March 2023. Please use the new identityProviderBase API.
      x-ms-pageable:
        nextLinkName: '@odata.nextLink'
        operationName: listMore
      x-ms-docs-operation-type: operation
    parameters:
      - name: b2xIdentityUserFlow-id
        in: path
        description: The unique identifier of b2xIdentityUserFlow
        required: true
        schema:
          type: string
        x-ms-docs-key-type: b2xIdentityUserFlow
  /identity/b2xUserFlows/{b2xIdentityUserFlow-id}/identityProviders/{identityProvider-id}:
    description: >-
      Provides operations to manage the identityProviders property of the
      microsoft.graph.b2xIdentityUserFlow entity.
    get:
      tags:
        - identity.b2xIdentityUserFlow
      summary: Microsoft Graph Get identityProviders from identity
      description: The identity providers included in the user flow.
      operationId: identity.b2xUserFlows.GetIdentityProviders
      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.identityProvider'
        4XX:
          $ref: '#/components/responses/error'
        5XX:
          $ref: '#/components/responses/error'
      deprecated: true
      x-ms-deprecation:
        removalDate: '2023-03-15'
        date: '2021-08-24'
        version: 2021-05/identityProvider
        description: >-
          The identityProvider API is deprecated and will stop returning data on
          March 2023. Please use the new identityProviderBase API.
      x-ms-docs-operation-type: operation
    parameters:
      - name: b2xIdentityUserFlow-id
        in: path
        description: The unique identifier of b2xIdentityUserFlow
        required: true
        schema:
          type: string
        x-ms-docs-key-type: b2xIdentityUserFlow
      - name: identityProvider-id
        in: path
        description: The unique identifier of identityProvider
        required: true
        schema:
          type: string
        x-ms-docs-key-type: identityProvider
  /identity/b2xUserFlows/{b2xIdentityUserFlow-id}/identityProviders/$count:
    description: Provides operations to count the resources in the collection.
    get:
      tags:
        - identity.b2xIdentityUserFlow
      summary: Microsoft Graph Get the number of the resource
      operationId: identity.b2xUserFlows.identityProviders.GetCount-97b6
      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'
      deprecated: true
      x-ms-deprecation:
        removalDate: '2023-03-15'
        date: '2021-08-24'
        version: 2021-05/identityProvider
        description: >-
          The identityProvider API is deprecated and will stop returning data on
          March 2023. Please use the new identityProviderBase API.
    parameters:
      - name: b2xIdentityUserFlow-id
        in: path
        description: The unique identifier of b2xIdentityUserFlow
        required: true
        schema:
          type: string
        x-ms-docs-key-type: b2xIdentityUserFlow
  /identity/identityProviders:
    description: >-
      Provides operations to manage the identityProviders property of the
      microsoft.graph.identityContainer entity.
    get:
      tags:
        - identity.identityProviderBase
      summary: Microsoft Graph List identityProviders
      description: >-
        Get a collection of identity provider resources that are configured for
        a tenant, and that are derived from identityProviderBase. For a
        Microsoft Entra tenant, the providers can be socialIdentityProviders or
        builtinIdentityProviders objects. For an Azure AD B2C, the providers can
        be socialIdentityProvider, or appleManagedIdentityProvider objects.
      externalDocs:
        description: Find more info here
        url: >-
          https://learn.microsoft.com/graph/api/identitycontainer-list-identityproviders?view=graph-rest-1.0
      operationId: identity.ListIdentityProviders
      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.identityProviderBaseCollectionResponse
        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:
        - identity.identityProviderBase
      summary: Microsoft Graph Create identityProvider
      description: >-
        Create an identity provider object that is of the type specified in the
        request body. Among the types of providers derived from
        identityProviderBase, you can currently create a socialIdentityProvider
        resource in Microsoft Entra ID. In Azure AD B2C, this operation can
        currently create a socialIdentityProvider, or an
        appleManagedIdentityProvider resource.
      externalDocs:
        description: Find more info here
        url: >-
          https://learn.microsoft.com/graph/api/identitycontainer-post-identityproviders?view=graph-rest-1.0
      operationId: identity.CreateIdentityProviders
      requestBody:
        description: New navigation property
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/microsoft.graph.identityProviderBase'
        required: true
      responses:
        2XX:
          description: Created navigation property.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/microsoft.graph.identityProviderBase'
        4XX:
          $ref: '#/components/responses/error'
        5XX:
          $ref: '#/components/responses/error'
      x-ms-docs-operation-type: operation
  /identity/identityProviders/{identityProviderBase-id}:
    description: >-
      Provides operations to manage the identityProviders property of the
      microsoft.graph.identityContainer entity.
    get:
      tags:
        - identity.identityProviderBase
      summary: Microsoft Graph Get identityProvider
      description: >-
        Get the properties and relationships of the specified identity provider
        configured in the tenant. Among the types of providers derived from
        identityProviderBase, you can currently get a socialIdentityProvider or
        a builtinIdentityProvider resource in Microsoft Entra ID. In Azure AD
        B2C, this operation can currently get a socialIdentityProvider, or an
        appleManagedIdentityProvider resource.
      externalDocs:
        description: Find more info here
        url: >-
          https://learn.microsoft.com/graph/api/identityproviderbase-get?view=graph-rest-1.0
      operationId: identity.GetIdentityProviders
      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.identityProviderBase'
        4XX:
          $ref: '#/components/responses/error'
        5XX:
          $ref: '#/components/responses/error'
      x-ms-docs-operation-type: operation
    patch:
      tags:
        - identity.identityProviderBase
      summary: Microsoft Graph Update identityProvider
      description: >-
        Update the properties of the specified identity provider configured in
        the tenant. Among the types of providers derived from
        identityProviderBase, you can currently update a socialIdentityProvider
        resource in Microsoft Entra ID. In Azure AD B2C, this operation can
        currently update a socialIdentityProvider, or an
        appleManagedIdentityProvider resource.
      externalDocs:
        description: Find more info here
        url: >-
          https://learn.microsoft.com/graph/api/identityproviderbase-update?view=graph-rest-1.0
      operationId: identity.UpdateIdentityProviders
      requestBody:
        description: New navigation property values
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/microsoft.graph.identityProviderBase'
        required: true
      responses:
        2XX:
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/microsoft.graph.identityProviderBase'
        4XX:
          $ref: '#/components/responses/error'
        5XX:
          $ref: '#/components/responses/error'
      x-ms-docs-operation-type: operation
    delete:
      tags:
        - identity.identityProviderBase
      summary: Microsoft Graph Delete identityProvider
      description: >-
        Delete an identity provider resource that is of the type specified by
        the id in the request. Among the types of providers derived from
        identityProviderBase, you can currently delete a socialIdentityProvider
        resource in Microsoft Entra ID. In Azure AD B2C, this operation can
        currently delete a socialIdentityProvider, or an
        appleManagedIdentityProvider resource.
      externalDocs:
        description: Find more info here
        url: >-
          https://learn.microsoft.com/graph/api/identityproviderbase-delete?view=graph-rest-1.0
      operationId: identity.DeleteIdentityProviders
      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: identityProviderBase-id
        in: path
        description: The unique identifier of identityProviderBase
        required: true
        schema:
          type: string
        x-ms-docs-key-type: identityProviderBase
  /identity/identityProviders/$count:
    description: Provides operations to count the resources in the collection.
    get:
      tags:
        - identity.identityProviderBase
      summary: Microsoft Graph Get the number of the resource
      operationId: identity.identityProviders.GetCount-7742
      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'
  /identity/identityProviders/availableProviderTypes():
    description: Provides operations to call the availableProviderTypes method.
    get:
      tags:
        - identity.identityProviderBase
      summary: Microsoft Graph Invoke function availableProviderTypes
      description: Get all identity providers supported in a directory.
      externalDocs:
        description: Find more info here
        url: >-
          https://learn.microsoft.com/graph/api/identityproviderbase-availableprovidertypes?view=graph-rest-1.0
      operationId: identity.identityProviders.availableProviderTypes
      parameters:
        - $ref: '#/components/parameters/top'
        - $ref: '#/components/parameters/skip'
        - $ref: '#/components/parameters/search'
        - $ref: '#/components/parameters/filter'
        - $ref: '#/components/parameters/count'
      responses:
        2XX:
          description: Success
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse'
                  - type: object
                    properties:
                      value:
                        type: array
                        items:
                          type: string
                          nullable: true
        4XX:
          $ref: '#/components/responses/error'
        5XX:
          $ref: '#/components/responses/error'
      x-ms-docs-operation-type: function
      x-ms-pageable:
        nextLinkName: '@odata.nextLink'
        operationName: listMore
  /identityProviders:
    description: Provides operations to manage the collection of identityProvider entities.
    get:
      tags:
        - identityProviders.identityProvider
      summary: Microsoft Graph List identityProviders (deprecated)
      description: Retrieve all identityProviders in the directory.
      externalDocs:
        description: Find more info here
        url: >-
          https://learn.microsoft.com/graph/api/identityprovider-list?view=graph-rest-1.0
      operationId: identityProviders.identityProvider.ListIdentityProvider
      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.identityProviderCollectionResponse
        4XX:
          $ref: '#/components/responses/error'
        5XX:
          $ref: '#/components/responses/error'
      deprecated: true
      x-ms-deprecation:
        removalDate: '2023-03-15'
        date: '2021-08-24'
        version: 2021-05/identityProvider
        description: >-
          The identityProvider API is deprecated and will stop returning data on
          March 2023. Please use the new identityProviderBase API.
      x-ms-pageable:
        nextLinkName: '@odata.nextLink'
        operationName: listMore
      x-ms-docs-operation-type: operation
    post:
      tags:
        - identityProviders.identityProvider
      summary: Microsoft Graph Create identityProvider (deprecated)
      description: >-
        Create a new identityProvider by specifying display name,
        identityProvider type, client ID, and client secret.
      externalDocs:
        description: Find more info here
        url: >-
          https://learn.microsoft.com/graph/api/identityprovider-post-identityproviders?view=graph-rest-1.0
      operationId: identityProviders.identityProvider.CreateIdentityProvider
      requestBody:
        description: New entity
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/microsoft.graph.identityProvider'
        required: true
      responses:
        2XX:
          description: Created entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/microsoft.graph.identityProvider'
        4XX:
          $ref: '#/components/responses/error'
        5XX:
          $ref: '#/components/responses/error'
      deprecated: true
      x-ms-deprecation:
        removalDate: '2023-03-15'
        date: '2021-08-24'
        version: 2021-05/identityProvider
        description: >-
          The identityProvider API is deprecated and will stop returning data on
          March 2023. Please use the new identityProviderBase API.
      x-ms-docs-operation-type: operation
  /identityProviders/{identityProvider-id}:
    description: Provides operations to manage the collection of identityProvider entities.
    get:
      tags:
        - identityProviders.identityProvider
      summary: Microsoft Graph Get identityProvider (deprecated)
      description: Retrieve the properties of an existing identityProvider.
      externalDocs:
        description: Find more info here
        url: >-
          https://learn.microsoft.com/graph/api/identityprovider-get?view=graph-rest-1.0
      operationId: identityProviders.identityProvider.GetIdentityProvider
      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.identityProvider'
        4XX:
          $ref: '#/components/responses/error'
        5XX:
          $ref: '#/components/responses/error'
      deprecated: true
      x-ms-deprecation:
        removalDate: '2023-03-15'
        date: '2021-08-24'
        version: 2021-05/identityProvider
        description: >-
          The identityProvider API is deprecated and will stop returning data on
          March 2023. Please use the new identityProviderBase API.
      x-ms-docs-operation-type: operation
    patch:
      tags:
        - identityProviders.identityProvider
      summary: Microsoft Graph Update identityProvider (deprecated)
      description: Update properties in an existing identityProvider.
      externalDocs:
        description: Find more info here
        url: >-
          https://learn.microsoft.com/graph/api/identityprovider-update?view=graph-rest-1.0
      operationId: identityProviders.identityProvider.UpdateIdentityProvider
      requestBody:
        description: New property values
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/microsoft.graph.identityProvider'
        required: true
      responses:
        2XX:
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/microsoft.graph.identityProvider'
        4XX:
          $ref: '#/components/responses/error'
        5XX:
          $ref: '#/components/responses/error'
      deprecated: true
      x-ms-deprecation:
        removalDate: '2023-03-15'
        date: '2021-08-24'
        version: 2021-05/identityProvider
        description: >-
          The identityProvider API is deprecated and will stop returning data on
          March 2023. Please use the new identityProviderBase API.
      x-ms-docs-operation-type: operation
    delete:
      tags:
        - identityProviders.identityProvider
      summary: Microsoft Graph Delete identityProvider (deprecated)
      description: Delete an existing identityProvider.
      externalDocs:
        description: Find more info here
        url: >-
          https://learn.microsoft.com/graph/api/identityprovider-delete?view=graph-rest-1.0
      operationId: identityProviders.identityProvider.DeleteIdentityProvider
      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'
      deprecated: true
      x-ms-deprecation:
        removalDate: '2023-03-15'
        date: '2021-08-24'
        version: 2021-05/identityProvider
        description: >-
          The identityProvider API is deprecated and will stop returning data on
          March 2023. Please use the new identityProviderBase API.
      x-ms-docs-operation-type: operation
    parameters:
      - name: identityProvider-id
        in: path
        description: The unique identifier of identityProvider
        required: true
        schema:
          type: string
        x-ms-docs-key-type: identityProvider
  /identityProviders/$count:
    description: Provides operations to count the resources in the collection.
    get:
      tags:
        - identityProviders.identityProvider
      summary: Microsoft Graph Get the number of the resource
      operationId: identityProviders.GetCount-a7d6
      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'
      deprecated: true
      x-ms-deprecation:
        removalDate: '2023-03-15'
        date: '2021-08-24'
        version: 2021-05/identityProvider
        description: >-
          The identityProvider API is deprecated and will stop returning data on
          March 2023. Please use the new identityProviderBase API.
  /identityProviders/availableProviderTypes():
    description: Provides operations to call the availableProviderTypes method.
    get:
      tags:
        - identityProviders.identityProvider.Functions
      summary: Microsoft Graph Invoke function availableProviderTypes
      description: Retrieves all identity provider types available in a directory.
      externalDocs:
        description: Find more info here
        url: >-
          https://learn.microsoft.com/graph/api/identityprovider-list-availableprovidertypes?view=graph-rest-1.0
      operationId: identityProviders.availableProviderTypes
      parameters:
        - $ref: '#/components/parameters/top'
        - $ref: '#/components/parameters/skip'
        - $ref: '#/components/parameters/search'
        - $ref: '#/components/parameters/filter'
        - $ref: '#/components/parameters/count'
      responses:
        2XX:
          description: Success
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse'
                  - type: object
                    properties:
                      value:
                        type: array
                        items:
                          type: string
                          nullable: true
        4XX:
          $ref: '#/components/responses/error'
        5XX:
          $ref: '#/components/responses/error'
      deprecated: true
      x-ms-deprecation:
        removalDate: '2023-03-15'
        date: '2021-08-24'
        version: 2021-05/identityProvider
        description: >-
          The identityProvider API is deprecated and will stop returning data on
          March 2023. Please use the new identityProviderBase API.
      x-ms-docs-operation-type: function
      x-ms-pageable:
        nextLinkName: '@odata.nextLink'
        operationName: listMore
components:
  schemas:
    microsoft.graph.identityProvider:
      allOf:
        - $ref: '#/components/schemas/microsoft.graph.entity'
        - title: identityProvider
          required:
            - '@odata.type'
          type: object
          properties:
            clientId:
              type: string
              description: >-
                The client ID for the application. This is the client ID
                obtained when registering the application with the identity
                provider. Required. Not nullable.
              nullable: true
            clientSecret:
              type: string
              description: >-
                The client secret for the application. This is the client secret
                obtained when registering the application with the identity
                provider. This is write-only. A read operation will return .  Required. Not nullable.
              nullable: true
            name:
              type: string
              description: The display name of the identity provider. Not nullable.
              nullable: true
            type:
              type: string
              description: >-
                The identity provider type is a required field. For B2B
                scenario: Google, Facebook. For B2C scenario: Microsoft, Google,
                Amazon, LinkedIn, Facebook, GitHub, Twitter, Weibo, QQ, WeChat,
                OpenIDConnect. Not nullable.
              nullable: true
            '@odata.type':
              type: string
      x-ms-discriminator-value: '#microsoft.graph.identityProvider'
    microsoft.graph.identityProviderBase:
      allOf:
        - $ref: '#/components/schemas/microsoft.graph.entity'
        - title: identityProviderBase
          required:
            - '@odata.type'
          type: object
          properties:
            displayName:
              type: string
              description: The display name of the identity provider.
              nullable: true
            '@odata.type':
              type: string
          discriminator:
            propertyName: '@odata.type'
            mapping:
              '#microsoft.graph.appleManagedIdentityProvider': >-
                #/components/schemas/microsoft.graph.appleManagedIdentityProvider
              '#microsoft.graph.builtInIdentityProvider': '#/components/schemas/microsoft.graph.builtInIdentityProvider'
              '#microsoft.graph.samlOrWsFedProvider': '#/components/schemas/microsoft.graph.samlOrWsFedProvider'
              '#microsoft.graph.internalDomainFederation': '#/components/schemas/microsoft.graph.internalDomainFederation'
              '#microsoft.graph.samlOrWsFedExternalDomainFederation': >-
                #/components/schemas/microsoft.graph.samlOrWsFedExternalDomainFederation
              '#microsoft.graph.socialIdentityProvider': '#/components/schemas/microsoft.graph.socialIdentityProvider'
    BaseCollectionPaginationCountResponse:
      title: Base collection pagination and count responses
      type: object
      properties:
        '@odata.count':
          type: integer
          format: int64
          nullable: true
        '@odata.nextLink':
          type: string
          nullable: true
  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'
    StringCollectionResponse:
      description: Retrieved collection
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/StringCollectionResponse'
tags:
  - name: identity.authenticationEventsFlow
  - name: identity.b2xIdentityUserFlow
  - name: identity.identityProviderBase
  - name: identityProviders.identityProvider
  - name: identityProviders.identityProvider.Functions