optionalClaims resource type
Namespace: microsoft.graph
Important
APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.
Declares the optional claims requested by an application. An application can configure optional claims to be returned in each of three types of tokens (ID token, access token, SAML 2 token) it can receive from the security token service. An application can configure a different set of optional claims to be returned in each token type. The optionalClaims property of the application is an optionalClaims object.
Application developers can configure optional claims in their Microsoft Entra apps to specify which claims they want in tokens sent to their application by the Microsoft security token service. See provide optional claims to your Microsoft Entra app for more information.
Properties
| Property | Type | Description |
|---|---|---|
| idToken | optionalClaim collection | The optional claims returned in the JWT ID token. |
| accessToken | optionalClaim collection | The optional claims returned in the JWT access token. |
| saml2Token | optionalClaim collection | The optional claims returned in the SAML token. |
Relationships
None.
JSON Representation
The following JSON representation shows the resource type.
{
"idToken": [{"@odata.type": "microsoft.graph.optionalClaim"}],
"accessToken": [{"@odata.type": "microsoft.graph.optionalClaim"}],
"saml2Token": [{"@odata.type": "microsoft.graph.optionalClaim"}]
}