onAttributeCollectionStartCustomExtension 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.

Used for creating a new custom extension based on the onAttributeCollectionStart event. This can be used to prefill attributes or block sign-up.

Inherits from customAuthenticationExtension.

Methods

Method Return type Description
Get onAttributeCollectionStartCustomExtension Read the properties and relationships of an onAttributeCollectionStartCustomExtension object.
Update onAttributeCollectionStartCustomExtension Update the properties of an onAttributeCollectionStartCustomExtension object.

Properties

Property Type Description
authenticationConfiguration customExtensionAuthenticationConfiguration Configuration for securing the API call. For example, using OAuth client credentials flow. Inherited from customCalloutExtension.
clientConfiguration customExtensionClientConfiguration HTTP connection settings that define how long Microsoft Entra ID can wait for a connection, how many times you can retry a timed-out connection and the exception scenarios when retries are allowed. Inherited from customCalloutExtension.
description String Description for the onAttributeCollectionStartCustomExtension object. Inherited from customCalloutExtension.
displayName String Display name for the onAttributeCollectionStartCustomExtension object. Inherited from customCalloutExtension.
endpointConfiguration customExtensionEndpointConfiguration The type and details for configuring the endpoint to call the app's workflow. Inherited from customCalloutExtension.
id String Identifier for the onAttributeCollectionStartCustomExtension object. Inherited from entity. Inherited from entity.

Relationships

None.

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.onAttributeCollectionStartCustomExtension",
  "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"
  }
}