api_connectors

Creates, updates, deletes, gets or lists an api_connectors resource.

Overview

Name	api_connectors
Type	Resource
Id	entra_id.identity.api_connectors

Fields

The following fields are returned by SELECT queries:

get

Retrieved navigation property

Name	Datatype	Description
id	string	The unique identifier for an entity. Read-only.
authenticationConfiguration		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.
targetUrl	string	The URL of the API endpoint to call.

list

Retrieved collection

Name	Datatype	Description
id	string	The unique identifier for an entity. Read-only.
authenticationConfiguration		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.
targetUrl	string	The URL of the API endpoint to call.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	identity_api_connector_id		Read the properties of an identityApiConnector object.
list	select			Read the properties of an identityApiConnector object.
insert	insert			Create a new identityApiConnector object.
update	update	identity_api_connector_id		Update the properties of an identityApiConnector object.
delete	delete	identity_api_connector_id	If-Match	Delete an identityApiConnector object.
upload_client_certificate	exec	identity_api_connector_id		Upload a PKCS 12 format key (.pfx) to an API connector's authentication configuration. The input is a base-64 encoded value of the PKCS 12 certificate contents. This method returns an apiConnector.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
identity_api_connector_id	string	The unique identifier of identityApiConnector
If-Match	string	ETag

SELECT examples

get

Read the properties of an identityApiConnector object.

SELECT
id,
authenticationConfiguration,
displayName,
targetUrl
FROM entra_id.identity.api_connectors
WHERE identity_api_connector_id = '{{ identity_api_connector_id }}' -- required
;

list

Read the properties of an identityApiConnector object.

SELECT
id,
authenticationConfiguration,
displayName,
targetUrl
FROM entra_id.identity.api_connectors
;

INSERT examples

insert

Create a new identityApiConnector object.

INSERT INTO entra_id.identity.api_connectors (
id,
authenticationConfiguration,
displayName,
targetUrl
)
SELECT 
'{{ id }}',
'{{ authenticationConfiguration }}',
'{{ displayName }}',
'{{ targetUrl }}'
RETURNING
id,
authenticationConfiguration,
displayName,
targetUrl
;

Manifest

# Description fields are for documentation purposes
- name: api_connectors
props:
  - name: id
    value: "{{ id }}"
    description: |
      The unique identifier for an entity. Read-only.
  - name: authenticationConfiguration
    value: "{{ authenticationConfiguration }}"
    description: |
      The object which describes the authentication configuration details for calling the API. Basic and PKCS 12 client certificate are supported.
  - name: displayName
    value: "{{ displayName }}"
    description: |
      The name of the API connector.
  - name: targetUrl
    value: "{{ targetUrl }}"
    description: |
      The URL of the API endpoint to call.

UPDATE examples

update

Update the properties of an identityApiConnector object.

UPDATE entra_id.identity.api_connectors
SET 
id = '{{ id }}',
authenticationConfiguration = '{{ authenticationConfiguration }}',
displayName = '{{ displayName }}',
targetUrl = '{{ targetUrl }}'
WHERE 
identity_api_connector_id = '{{ identity_api_connector_id }}' --required
RETURNING
id,
authenticationConfiguration,
displayName,
targetUrl;

DELETE examples

delete

Delete an identityApiConnector object.

DELETE FROM entra_id.identity.api_connectors
WHERE identity_api_connector_id = '{{ identity_api_connector_id }}' --required
AND If-Match = '{{ If-Match }}'
;

Lifecycle Methods

upload_client_certificate

Upload a PKCS 12 format key (.pfx) to an API connector's authentication configuration. The input is a base-64 encoded value of the PKCS 12 certificate contents. This method returns an apiConnector.

EXEC entra_id.identity.api_connectors.upload_client_certificate 
@identity_api_connector_id='{{ identity_api_connector_id }}' --required 
@@json=
'{
"pkcs12Value": "{{ pkcs12Value }}", 
"password": "{{ password }}"
}'
;