Skip to content

Commit 5222c67

Browse files
authored
Merge branch 'main' into tannikaM-patch-1
2 parents 19303f4 + d8df4b0 commit 5222c67

File tree

3 files changed

+12
-13
lines changed

3 files changed

+12
-13
lines changed

api-reference/beta/api/identitycontainer-post-identityproviders.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -91,15 +91,16 @@ All the properties listed in the following tables are required.
9191
### oidcIdentityProvider object
9292

9393
|Property|Type|Description|
94-
|:---------------|:--------|:----------|
95-
|displayName|String|The display name of the identity provider.|
94+
|:---|:---|:---|
95+
|clientAuthentication|[oidcClientAuthentication](../resources/oidcclientauthentication.md)|The client authentication settings.<li> Use the **oidcClientSecretAuthentication** derived complex type for setting up your identity provider with `client_secret_post` or `client_secret_jwt authentication` methods. <li> Use the **oidcPrivateJwtKeyClientAuthentication** type for setting up your identity provider with `private_key_jwt` authentication method. <br><br>Due to security reasons, `client_secret_basic` authentication method isn't supported.|
9696
|clientId|String|The client ID for the application obtained when registering the application with the identity provider.|
97+
|displayName|String|The display name of the identity provider. Inherited from [identityProviderBase](../resources/identityproviderbase.md).|
98+
|id|String|The identifier of the identity provider.Required. Inherited from [identityProviderBase](../resources/identityproviderbase.md). Inherits from [entity](../resources/entity.md)|
99+
|inboundClaimMapping|[oidcInboundClaimMappingOverride](../resources/oidcinboundclaimmappingoverride.md)|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.|
97100
|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.<br> **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.|
98-
|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`.<br> **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](https://openid.net/specs/openid-connect-discovery-1_0.html) specifications for more details.|
99-
|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: <br>`code`: As per the authorization code flow, a code is returned back to Entra External ID. Entra External ID proceeds to call the token_endpoint to exchange the code for the token.<br>`id_token`: An ID token is returned back to Entra External ID from the custom identity provider. (This value is not supported at the moment).<br>`token`: An access token is returned back to Entra External ID from the custom identity provider. (This value is not supported at the moment).|
101+
|responseType|oidcResponseType|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: <li>`code`: As per the authorization code flow, a code is returned back to Entra External ID. Entra External ID proceeds to call the token_endpoint to exchange the code for the token.<li>`id_token`: An ID token is returned back to Entra External ID from the custom identity provider. (This value is not supported at the moment).<li>`token`: An access token is returned back to Entra External ID from the custom identity provider. This value is currently unsupported.|
100102
|scope|String|Scope defines the information and permissions you are looking to gather from your custom identity provider.|
101-
|clientAuthentication|[clientAuthentication](../resources/oidcclientauthentication.md)|The client authentication settings.<br> use **`oidcClientSecretAuthentication`** type for setting up your identity provider with `client_secret_post` or `client_secret_jwt authentication` methods. <br> use **`oidcPrivateJwtKeyClientAuthentication`** type for setting up your identity provider with `private_key_jwt` authentication method. <br>Due to security reasons, `client_secret_basic` authentication method is not supported.|
102-
|inboundclaimMapping|[inboundclaimMapping](../resources/oidcinboundclaimmappingoverride.md)|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.|
103+
|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`.<br> **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](https://openid.net/specs/openid-connect-discovery-1_0.html) specifications for more details.|
103104

104105
## Response
105106

api-reference/beta/api/identityproviderbase-get.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -374,22 +374,20 @@ Content-type: application/json
374374
}
375375
```
376376

377-
### Example 5: Retrieve an **OpenID Connect identity provider** (external tenant)
377+
### Example 5: Retrieve an **OIDC identity provider** (External tenant)
378378

379379
#### Request
380380

381381
The following example shows a request.
382382

383383
<!-- {
384384
"blockType": "request",
385-
"name": "get_applemanagedidentityprovider_from_identityproviderbase",
386-
"sampleKeys": ["Apple-Managed-OIDC"]
387-
}
385+
"name": "get_oidcidentityprovider_from_identityproviderbase",
386+
}
388387
-->
389-
390388
``` http
391389
GET https://graph.microsoft.com/beta/identity/identityProviders/12345678-abcd-1234-cdef-aaaaaaaaaaaa
392-
---
390+
```
393391

394392
#### Response
395393

api-reference/beta/resources/socialidentityprovider.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Inherits from [identityProviderBase](../resources/identityproviderbase.md).
2727

2828
## Methods
2929

30-
None.
30+
None.
3131

3232
For the list of API operations for managing social identity providers, see the [identityProviderBase](../resources/identityproviderbase.md) resource type.
3333

0 commit comments

Comments
 (0)