certificate_based_auth_configuration

Creates, updates, deletes, gets or lists a certificate_based_auth_configuration resource.

Overview

Name	certificate_based_auth_configuration
Type	Resource
Id	entra_id.organization.certificate_based_auth_configuration

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.
certificateAuthorities	array	Collection of certificate authorities which creates a trusted certificate chain.

list

Retrieved collection

Name	Datatype	Description
id	string	The unique identifier for an entity. Read-only.
certificateAuthorities	array	Collection of certificate authorities which creates a trusted certificate chain.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	organization_id, certificate_based_auth_configuration_id		Get the properties of a certificateBasedAuthConfiguration object.
list	select	organization_id		Get a list of certificateBasedAuthConfiguration objects.
insert	insert	organization_id		Create a new certificateBasedAuthConfiguration object.
delete	delete	organization_id, certificate_based_auth_configuration_id	If-Match	Delete a certificateBasedAuthConfiguration object.

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
certificate_based_auth_configuration_id	string	The unique identifier of certificateBasedAuthConfiguration
organization_id	string	The unique identifier of organization
If-Match	string	ETag

SELECT examples

get

Get the properties of a certificateBasedAuthConfiguration object.

SELECT
id,
certificateAuthorities
FROM entra_id.organization.certificate_based_auth_configuration
WHERE organization_id = '{{ organization_id }}' -- required
AND certificate_based_auth_configuration_id = '{{ certificate_based_auth_configuration_id }}' -- required
;

list

Get a list of certificateBasedAuthConfiguration objects.

SELECT
id,
certificateAuthorities
FROM entra_id.organization.certificate_based_auth_configuration
WHERE organization_id = '{{ organization_id }}' -- required
;

INSERT examples

insert

Create a new certificateBasedAuthConfiguration object.

INSERT INTO entra_id.organization.certificate_based_auth_configuration (
id,
certificateAuthorities,
organization_id
)
SELECT 
'{{ id }}',
'{{ certificateAuthorities }}',
'{{ organization_id }}'
RETURNING
id,
certificateAuthorities
;

Manifest

# Description fields are for documentation purposes
- name: certificate_based_auth_configuration
props:
  - name: organization_id
    value: "{{ organization_id }}"
    description: Required parameter for the certificate_based_auth_configuration resource.
  - name: id
    value: "{{ id }}"
    description: |
      The unique identifier for an entity. Read-only.
  - name: certificateAuthorities
    description: |
      Collection of certificate authorities which creates a trusted certificate chain.
    value:
      - certificate: "{{ certificate }}"
        certificateRevocationListUrl: "{{ certificateRevocationListUrl }}"
        deltaCertificateRevocationListUrl: "{{ deltaCertificateRevocationListUrl }}"
        isRootAuthority: {{ isRootAuthority }}
        issuer: "{{ issuer }}"
        issuerSki: "{{ issuerSki }}"

DELETE examples

delete

Delete a certificateBasedAuthConfiguration object.

DELETE FROM entra_id.organization.certificate_based_auth_configuration
WHERE organization_id = '{{ organization_id }}' --required
AND certificate_based_auth_configuration_id = '{{ certificate_based_auth_configuration_id }}' --required
AND If-Match = '{{ If-Match }}'
;