Skip to content

identityproviderbase-update.md

Latest commit

 

History

History
377 lines (272 loc) · 17.9 KB

identityproviderbase-update.md

File metadata and controls

377 lines (272 loc) · 17.9 KB
title Update identityProvider
description Update the properties of an identityProvider.
ms.localizationpriority medium
doc_type apiPageType
author brozbab
ms.subservice entra-sign-in
ms.date 11/16/2024

Update identityProvider

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

Update the properties of the specified external identity provider configured in the tenant.

Among the types of providers derived from identityProviderBase, in Microsoft Entra, this operation can update a socialIdentityProvider, appleManagedIdentityProvider (external tenant only), or an oidcIdentityProvider (external tenant only) resource.

In Azure AD B2C, this operation can update a socialIdentityProvider, appleManagedIdentityProvider, builtinIdentityProvider, or an openIdConnectIdentityProvider resource.

[!INCLUDE national-cloud-support]

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

[!INCLUDE permissions-table]

[!INCLUDE rbac-identity-provider-apis]

HTTP request

PATCH /identity/identityProviders/{id}

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.
Content-Type application/json. Required.

Request body

In Microsoft Entra External ID, provide a JSON object the request body with one or more properties that need to be updated for a socialIdentityProvider appleManagedIdentityProvider, or oidcIdentityProvider object.

In Azure AD B2C, provide a JSON object the request body with one or more properties that need to be updated for a socialIdentityProvider, appleManagedIdentityProvider, or an openIdConnectIdentityProvider object.

socialIdentityProvider object

Property Type Description
clientId String The client identifier for the application obtained when registering the application with the identity provider.
clientSecret String The client secret for the application that is obtained when the application is registered with the identity provider. This is write-only. A read operation returns ****.
displayName String The display name of the identity provider.
identityProviderType String For external and workforce tenants, possible values: Facebook, Google.
For Azure AD B2C tenants, possible values: Microsoft, Google, Amazon, LinkedIn, Facebook, GitHub, Twitter, Weibo, QQ, WeChat.

appleManagedIdentityProvider object

Property Type Description
certificateData String The certificate data which is a long string of text from the certificate, can be null.
developerId String The Apple developer identifier.
displayName String The display name of the identity provider.
keyId String The Apple key identifier.
serviceId String The Apple service identifier.

openIdConnectIdentityProvider object

Property Type Description
claimsMapping claimsMapping After the OIDC provider sends an ID token back to Microsoft Entra ID, Microsoft Entra ID needs to be able to map the claims from the received token to the claims that Microsoft Entra ID recognizes and uses. This complex type captures that mapping.
clientId String The client identifier for the application obtained when registering the application with the identity provider.
clientSecret String The client secret for the application obtained when registering the application with the identity provider. The clientSecret has a dependency on responseType.
  • When responseType is code, a secret is required for the auth code exchange.
  • When responseType is id_token the secret is not required because there is no code exchange in the authentication pipeline. In this mode, the id_token is returned directly from the authorization response.
displayName String The display name of the identity provider.
domainHint String The domain hint can be used to skip directly to the sign in page of the specified identity provider, instead of having the user make a selection among the list of available identity providers.
metadataUrl String The URL for the metadata document of the OpenID Connect identity provider. Every OpenID Connect identity provider describes a metadata document that contains most of the information required to perform sign-in. This includes information such as the URLs to use and the location of the service's public signing keys. The OpenID Connect metadata document is always located at an endpoint that ends in .well-known/openid-configuration. Provide the metadata URL for the OpenID Connect identity provider you add.
responseMode String The response mode defines the method used to send data back from the custom identity provider to Azure AD B2C. Possible values: form_post, query.
responseType String The response type describes the type of information sent back in the initial call to the authorization_endpoint of the custom identity provider. Possible values: code , id_token , token.
scope String Scope defines the information and permissions you are looking to gather from your custom identity provider.

oidcIdentityProvider object

Property Type Description
clientAuthentication clientAuthentication The client authentication settings.
  • use oidcClientSecretAuthentication type for setting up your identity provider with client_secret_post or client_secret_jwt authentication methods.
  • use oidcPrivateJwtKeyClientAuthentication type for setting up your identity provider with private_key_jwt authentication method.
  • Due to security reasons, client_secret_basic authentication method is not supported.
    		•
    clientId String The client ID for the application obtained when registering the application with the identity provider.
    displayName String The display name of the identity provider.
    inboundclaimMapping inboundclaimMapping After the OIDC provider sends an ID token back to Microsoft Entra External ID, Microsoft Entra External ID needs to be able to map the claims from the received token to the claims that Microsoft Entra ID recognizes and uses. This complex type captures that mapping.
    issuer String The issuer URI. Issuer URI is a case-sensitive URL using https scheme contains scheme, host, and optionally, port number and path components and no query or fragment components.
    Note: Configuring other Microsoft Entra tenants as an external identity provider is currently not supported. As a result, the microsoftonline.com domain in the issuer URI is not accepted.
    responseType String The response type describes the type of information sent back in the initial call to the authorization_endpoint of the custom identity provider. Possible values: code , id_token , token.
    scope String Scope defines the information and permissions you are looking to gather from your custom identity provider.
    wellKnownEndpoint String The URL for the metadata document of the OpenID Connect identity provider. Every OpenID Connect identity provider describes a metadata document that contains most of the information required to perform sign-in. This includes information such as the URLs to use and the location of the service's public signing keys. The OpenID Connect metadata document is always located at an endpoint that ends in .well-known/openid-configuration.
    Note: The metadata document should, at minimum, contain the following properties: issuer, authorization_endpoint, token_endpoint, token_endpoint_auth_methods_supported, response_types_supported, subject_types_supported and jwks_uri. Visit OpenID Connect Discovery specifications for more details.

    Response

    If successful, this method returns a 204 No Content response code. If unsuccessful, a 4xx error will be returned with specific details.

    Examples

    Example 1: Update a social identity provider

    Request

    The following example shows a request.

    HTTP

    PATCH https://graph.microsoft.com/beta/identity/identityProviders/Amazon-OAUTH
Content-type: application/json

{
  "@odata.type": "#microsoft.graph.socialIdentityProvider",
  "clientSecret": "4294967296"
}

    C#

    [!INCLUDE sample-code] [!INCLUDE sdk-documentation]

    Go

    [!INCLUDE sample-code] [!INCLUDE sdk-documentation]

    Java

    [!INCLUDE sample-code] [!INCLUDE sdk-documentation]

    JavaScript

    [!INCLUDE sample-code] [!INCLUDE sdk-documentation]

    PHP

    [!INCLUDE sample-code] [!INCLUDE sdk-documentation]

    PowerShell

    [!INCLUDE sample-code] [!INCLUDE sdk-documentation]

    Python

    [!INCLUDE sample-code] [!INCLUDE sdk-documentation]

    Response

    The following example shows the response.

    HTTP/1.1 204 No Content

    Example 2: Update an Apple identity provider

    Request

    The following example shows a request.

    HTTP

    PATCH https://graph.microsoft.com/beta/identity/identityProviders/Apple-Managed-OIDC
Content-type: application/json

{
  "@odata.type": "#microsoft.graph.socialIdentityProvider",
  "displayName": "Apple"
}

    C#

    [!INCLUDE sample-code] [!INCLUDE sdk-documentation]

    Go

    [!INCLUDE sample-code] [!INCLUDE sdk-documentation]

    Java

    [!INCLUDE sample-code] [!INCLUDE sdk-documentation]

    JavaScript

    [!INCLUDE sample-code] [!INCLUDE sdk-documentation]

    PHP

    [!INCLUDE sample-code] [!INCLUDE sdk-documentation]

    PowerShell

    [!INCLUDE sample-code] [!INCLUDE sdk-documentation]

    Python

    [!INCLUDE sample-code] [!INCLUDE sdk-documentation]

    Response

    The following example shows the response.

    HTTP/1.1 204 No Content

    Example 3: Update an OpenID Connect identity provider (Azure AD B2C tenant)

    Request

    The following example shows a request.

    HTTP

    PATCH https://graph.microsoft.com/beta/identity/identityProviders/Contoso-OIDC-00001111-aaaa-2222-bbbb-3333cccc4444
Content-type: application/json

{
  "@odata.type": "#microsoft.graph.openIdConnectIdentityProvider",
  "responseType": "id_token"
}

    C#

    [!INCLUDE sample-code] [!INCLUDE sdk-documentation]

    Go

    [!INCLUDE sample-code] [!INCLUDE sdk-documentation]

    Java

    [!INCLUDE sample-code] [!INCLUDE sdk-documentation]

    JavaScript

    [!INCLUDE sample-code] [!INCLUDE sdk-documentation]

    PHP

    [!INCLUDE sample-code] [!INCLUDE sdk-documentation]

    PowerShell

    [!INCLUDE sample-code] [!INCLUDE sdk-documentation]

    Python

    [!INCLUDE sample-code] [!INCLUDE sdk-documentation]

    Response

    The following example shows the response.

    HTTP/1.1 204 No Content

    Example 4: Update an OpenID Connect identity provider (external tenant)

    Request

    The following example shows a request.

    HTTP

    PATCH https://graph.microsoft.com/beta/identity/identityProviders/ContosoOIDCIdentityProvider
Content-type: application/json

{
  "@odata.type": "#microsoft.graph.oidcIdentityProvider",
  "displayName": "Contoso"
}

    C#

    [!INCLUDE sample-code] [!INCLUDE sdk-documentation]

    Go

    [!INCLUDE sample-code] [!INCLUDE sdk-documentation]

    Java

    [!INCLUDE sample-code] [!INCLUDE sdk-documentation]

    JavaScript

    [!INCLUDE sample-code] [!INCLUDE sdk-documentation]

    PHP

    [!INCLUDE sample-code] [!INCLUDE sdk-documentation]

    PowerShell

    [!INCLUDE sample-code] [!INCLUDE sdk-documentation]

    Python

    [!INCLUDE sample-code] [!INCLUDE sdk-documentation]

    Response

    The following example shows the response.

    HTTP/1.1 204 No Content