Edit

Share via

identityApiConnector resource type

  • Article

Namespace: microsoft.graph

Represents API connectors in a Microsoft Entra tenants.

An API connector used in your Microsoft Entra External ID self-service 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 a client certificate identityApiConnector Upload a client certificate to use for authentication.
Delete None Delete an API connector.

Properties

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

Relationships

None.

JSON representation

The following JSON representation shows the resource type.

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