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

Represents API connectors in a Microsoft Entra ID and Azure AD B2C tenants.

An API connector used in your Microsoft Entra External ID self-service sign-up and Azure AD B2C sign-up user flows allows you to call an API during the execution of the user flow. An API connector provides the information needed to call an API including an endpoint URL and authentication. An API connector can be used at a specific step in a user flow to affect the execution of the user flow. For example, the API response can block a user from signing up, show an input validation error, or overwrite user collected attributes.

Use the b2xIdentityUserFlow API to use an API connector from an External Identities self-service sign-up user flow.

Methods

Method	Return type	Description
List	identityApiConnector collection	Get a list of API connectors
Create	identityApiConnector	Create a new API connector.
Get	identityApiConnector	Read the properties of an identityApiConnector object.
Update	identityApiConnector	Update the properties of an API connector.
Upload client certificate	identityApiConnector	Upload a client certificate to use for authentication.
Delete	None	Delete an API connector.

Properties

Property	Type	Description
id	String	The randomly generated ID of the API connector.
displayName	String	The name of the API connector.
targetUrl	String	The URL of the API endpoint to call.
authenticationConfiguration	apiAuthenticationConfigurationBase	The object which describes the authentication configuration details for calling the API. Basic and PKCS 12 client certificate are supported.

Relationships

None.

JSON representation

The following is a JSON representation of the resource.

{
  "@odata.type": "#microsoft.graph.identityApiConnector",
  "id": "String (identifier)",
  "displayName": "String",
  "targetUrl": "String",
  "authenticationConfiguration": {
    "@odata.type": "microsoft.graph.apiAuthenticationConfigurationBase"
  }
}