public_key_infrastructure_certificate_based_auth_configurations_certificate_authorities

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

Overview

Name	public_key_infrastructure_certificate_based_auth_configurations_certificate_authorities
Type	Resource
Id	entra_id.directory.public_key_infrastructure_certificate_based_auth_configurations_certificate_authorities

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.
certificate	string (base64url)	The public key of the certificate authority.
certificateAuthorityType		The type of certificate authority. The possible values are: root, intermediate, unknownFutureValue. Supports $filter (eq).
certificateRevocationListUrl	string	The URL to check if the certificate is revoked.
createdDateTime	string (date-time)	The date and time when the certificate authority was created. (pattern: ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$)
deletedDateTime	string (date-time)	Date and time when this object was deleted. Always null when the object hasn't been deleted. (pattern: ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$)
deltaCertificateRevocationListUrl	string
displayName	string	The display name of the certificate authority.
expirationDateTime	string (date-time)	The date and time when the certificate authority expires. Supports $filter (eq) and $orderby. (pattern: ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$)
isIssuerHintEnabled	boolean	Indicates whether the certificate picker presents the certificate authority to the user to use for authentication. Default value is false. Optional.
issuer	string	The issuer of the certificate authority.
issuerSubjectKeyIdentifier	string	The subject key identifier of certificate authority.
thumbprint	string	The thumbprint of certificate authority certificate. Supports $filter (eq, startswith).

list

Retrieved collection

Name	Datatype	Description
id	string	The unique identifier for an entity. Read-only.
certificate	string (base64url)	The public key of the certificate authority.
certificateAuthorityType		The type of certificate authority. The possible values are: root, intermediate, unknownFutureValue. Supports $filter (eq).
certificateRevocationListUrl	string	The URL to check if the certificate is revoked.
createdDateTime	string (date-time)	The date and time when the certificate authority was created. (pattern: ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$)
deletedDateTime	string (date-time)	Date and time when this object was deleted. Always null when the object hasn't been deleted. (pattern: ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$)
deltaCertificateRevocationListUrl	string
displayName	string	The display name of the certificate authority.
expirationDateTime	string (date-time)	The date and time when the certificate authority expires. Supports $filter (eq) and $orderby. (pattern: ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$)
isIssuerHintEnabled	boolean	Indicates whether the certificate picker presents the certificate authority to the user to use for authentication. Default value is false. Optional.
issuer	string	The issuer of the certificate authority.
issuerSubjectKeyIdentifier	string	The subject key identifier of certificate authority.
thumbprint	string	The thumbprint of certificate authority certificate. Supports $filter (eq, startswith).

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	certificate_based_auth_pki_id, certificate_authority_detail_id		The collection of certificate authorities contained in this public key infrastructure resource.
list	select	certificate_based_auth_pki_id		Get a list of the certificateAuthorityDetail objects and their properties.
insert	insert	certificate_based_auth_pki_id		Create a new certificateAuthorityDetail object.
update	update	certificate_based_auth_pki_id, certificate_authority_detail_id
delete	delete	certificate_based_auth_pki_id, certificate_authority_detail_id	If-Match	Delete a certificateAuthorityDetail 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_authority_detail_id	string	The unique identifier of certificateAuthorityDetail
certificate_based_auth_pki_id	string	The unique identifier of certificateBasedAuthPki
If-Match	string	ETag

SELECT examples

get

The collection of certificate authorities contained in this public key infrastructure resource.

SELECT
id,
certificate,
certificateAuthorityType,
certificateRevocationListUrl,
createdDateTime,
deletedDateTime,
deltaCertificateRevocationListUrl,
displayName,
expirationDateTime,
isIssuerHintEnabled,
issuer,
issuerSubjectKeyIdentifier,
thumbprint
FROM entra_id.directory.public_key_infrastructure_certificate_based_auth_configurations_certificate_authorities
WHERE certificate_based_auth_pki_id = '{{ certificate_based_auth_pki_id }}' -- required
AND certificate_authority_detail_id = '{{ certificate_authority_detail_id }}' -- required
;

list

Get a list of the certificateAuthorityDetail objects and their properties.

SELECT
id,
certificate,
certificateAuthorityType,
certificateRevocationListUrl,
createdDateTime,
deletedDateTime,
deltaCertificateRevocationListUrl,
displayName,
expirationDateTime,
isIssuerHintEnabled,
issuer,
issuerSubjectKeyIdentifier,
thumbprint
FROM entra_id.directory.public_key_infrastructure_certificate_based_auth_configurations_certificate_authorities
WHERE certificate_based_auth_pki_id = '{{ certificate_based_auth_pki_id }}' -- required
;

INSERT examples

insert

Create a new certificateAuthorityDetail object.

INSERT INTO entra_id.directory.public_key_infrastructure_certificate_based_auth_configurations_certificate_authorities (
id,
deletedDateTime,
certificate,
certificateAuthorityType,
certificateRevocationListUrl,
createdDateTime,
deltaCertificateRevocationListUrl,
displayName,
expirationDateTime,
isIssuerHintEnabled,
issuer,
issuerSubjectKeyIdentifier,
thumbprint,
certificate_based_auth_pki_id
)
SELECT 
'{{ id }}',
'{{ deletedDateTime }}',
'{{ certificate }}',
'{{ certificateAuthorityType }}',
'{{ certificateRevocationListUrl }}',
'{{ createdDateTime }}',
'{{ deltaCertificateRevocationListUrl }}',
'{{ displayName }}',
'{{ expirationDateTime }}',
{{ isIssuerHintEnabled }},
'{{ issuer }}',
'{{ issuerSubjectKeyIdentifier }}',
'{{ thumbprint }}',
'{{ certificate_based_auth_pki_id }}'
RETURNING
id,
certificate,
certificateAuthorityType,
certificateRevocationListUrl,
createdDateTime,
deletedDateTime,
deltaCertificateRevocationListUrl,
displayName,
expirationDateTime,
isIssuerHintEnabled,
issuer,
issuerSubjectKeyIdentifier,
thumbprint
;

Manifest

# Description fields are for documentation purposes
- name: public_key_infrastructure_certificate_based_auth_configurations_certificate_authorities
props:
  - name: certificate_based_auth_pki_id
    value: "{{ certificate_based_auth_pki_id }}"
    description: Required parameter for the public_key_infrastructure_certificate_based_auth_configurations_certificate_authorities resource.
  - name: id
    value: "{{ id }}"
    description: |
      The unique identifier for an entity. Read-only.
  - name: deletedDateTime
    value: "{{ deletedDateTime }}"
    description: |
      Date and time when this object was deleted. Always null when the object hasn't been deleted.
  - name: certificate
    value: "{{ certificate }}"
    description: |
      The public key of the certificate authority.
  - name: certificateAuthorityType
    value: "{{ certificateAuthorityType }}"
    description: |
      The type of certificate authority. The possible values are: root, intermediate, unknownFutureValue. Supports $filter (eq).
  - name: certificateRevocationListUrl
    value: "{{ certificateRevocationListUrl }}"
    description: |
      The URL to check if the certificate is revoked.
  - name: createdDateTime
    value: "{{ createdDateTime }}"
    description: |
      The date and time when the certificate authority was created.
  - name: deltaCertificateRevocationListUrl
    value: "{{ deltaCertificateRevocationListUrl }}"
  - name: displayName
    value: "{{ displayName }}"
    description: |
      The display name of the certificate authority.
  - name: expirationDateTime
    value: "{{ expirationDateTime }}"
    description: |
      The date and time when the certificate authority expires. Supports $filter (eq) and $orderby.
  - name: isIssuerHintEnabled
    value: {{ isIssuerHintEnabled }}
    description: |
      Indicates whether the certificate picker presents the certificate authority to the user to use for authentication. Default value is false. Optional.
  - name: issuer
    value: "{{ issuer }}"
    description: |
      The issuer of the certificate authority.
  - name: issuerSubjectKeyIdentifier
    value: "{{ issuerSubjectKeyIdentifier }}"
    description: |
      The subject key identifier of certificate authority.
  - name: thumbprint
    value: "{{ thumbprint }}"
    description: |
      The thumbprint of certificate authority certificate. Supports $filter (eq, startswith).

UPDATE examples

update

No description available.

UPDATE entra_id.directory.public_key_infrastructure_certificate_based_auth_configurations_certificate_authorities
SET 
id = '{{ id }}',
deletedDateTime = '{{ deletedDateTime }}',
certificate = '{{ certificate }}',
certificateAuthorityType = '{{ certificateAuthorityType }}',
certificateRevocationListUrl = '{{ certificateRevocationListUrl }}',
createdDateTime = '{{ createdDateTime }}',
deltaCertificateRevocationListUrl = '{{ deltaCertificateRevocationListUrl }}',
displayName = '{{ displayName }}',
expirationDateTime = '{{ expirationDateTime }}',
isIssuerHintEnabled = {{ isIssuerHintEnabled }},
issuer = '{{ issuer }}',
issuerSubjectKeyIdentifier = '{{ issuerSubjectKeyIdentifier }}',
thumbprint = '{{ thumbprint }}'
WHERE 
certificate_based_auth_pki_id = '{{ certificate_based_auth_pki_id }}' --required
AND certificate_authority_detail_id = '{{ certificate_authority_detail_id }}' --required
RETURNING
id,
certificate,
certificateAuthorityType,
certificateRevocationListUrl,
createdDateTime,
deletedDateTime,
deltaCertificateRevocationListUrl,
displayName,
expirationDateTime,
isIssuerHintEnabled,
issuer,
issuerSubjectKeyIdentifier,
thumbprint;

DELETE examples

delete

Delete a certificateAuthorityDetail object.

DELETE FROM entra_id.directory.public_key_infrastructure_certificate_based_auth_configurations_certificate_authorities
WHERE certificate_based_auth_pki_id = '{{ certificate_based_auth_pki_id }}' --required
AND certificate_authority_detail_id = '{{ certificate_authority_detail_id }}' --required
AND If-Match = '{{ If-Match }}'
;