customAuthenticationExtension 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.
Custom authentication extensions define interactions with external systems during a user authentication session. This is an abstract type from which the following types are derived.
- onTokenIssuanceStartCustomExtension resource type.
- onAttributeCollectionStartCustomExtension resource type.
- onAttributeCollectionSubmitCustomExtension resource type.
Inherits from customCalloutExtension.
Learn how to use this API when Configuring a custom claim provider token issuance event (preview).
Note
You can have a maximum of 100 custom extension policies.
Methods
Method | Return type | Description |
---|---|---|
List | customAuthenticationExtension collection | Retrieve a list of the object types that are derived from customAuthenticationExtension. |
Create | customAuthenticationExtension | Create a new object type that is derived from customAuthenticationExtension. |
Get | customAuthenticationExtension | Read the properties and relationships of an object type that is derived from customAuthenticationExtension. |
Update | None | Update the properties of an object type that is derived from customAuthenticationExtension. |
Delete | None | Delete an object type that is derived from customAuthenticationExtension. |
Validate authentication configuration | authenticationConfigurationValidation | Check the validity of the endpoint and authentication configuration for a customAuthenticationExtension object. |
Properties
Property | Type | Description |
---|---|---|
authenticationConfiguration | customExtensionAuthenticationConfiguration | The authentication configuration for the customAuthenticationExtension. Inherited from customCalloutExtension. |
clientConfiguration | customExtensionClientConfiguration | The connection settings for the customAuthenticationExtension. Inherited from customCalloutExtension. |
description | String | The description of the customAuthenticationExtension. Inherited from customCalloutExtension. |
displayName | String | The display name for the customAuthenticationExtension. Inherited from customCalloutExtension. |
endpointConfiguration | customExtensionEndpointConfiguration | The HTTP endpoint that this custom extension calls. Inherited from customCalloutExtension. |
id | String | Identifier for the customAuthenticationExtension. Inherited from entity. |
Relationships
None.
JSON representation
The following JSON representation shows the resource type.
{
"@odata.type": "#microsoft.graph.customAuthenticationExtension",
"id": "String (identifier)",
"authenticationConfiguration": {
"@odata.type": "microsoft.graph.customExtensionAuthenticationConfiguration"
},
"clientConfiguration": {
"@odata.type": "microsoft.graph.customExtensionClientConfiguration"
},
"description": "String",
"displayName": "String",
"endpointConfiguration": {
"@odata.type": "microsoft.graph.customExtensionEndpointConfiguration"
}
}