certificate_authorities

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

Overview

Name	certificate_authorities
Type	Resource
Id	confluent.iam.certificate_authorities

Fields

The following fields are returned by SELECT queries:

get_iam_v2_certificate_authority

Certificate Authority.

Name	Datatype	Description
id	string	ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object kinds or objects of the same kind within a different scope/namespace ("space"). (example: dlz-f3a90de)
display_name	string	The human-readable name of the certificate authority. (example: My Certificate Authority)
api_version	string	APIVersion defines the schema version of this representation of a resource. (iam/v2)
certificate_chain_filename	string	The file name of the uploaded pem file for this certificate authority. (example: certificate.pem)
crl_source	string	The source specifies whether the Certificate Revocation List (CRL) is updated from either local file uploaded (LOCAL) or from url of CRL (URL). (example: LOCAL)
crl_updated_at	string (date-time)	The timestamp for when CRL was last updated. (example: 2017-07-21T17:32:28.000Z)
crl_url	string (uri)	The url from which to fetch the CRL for the certificate authority if crl_source is URL.
description	string	A description of the certificate authority. (example: Sample description text)
expiration_dates	array	The expiration dates of certificates in the chain.
fingerprints	array	The fingerprints for each certificate in the certificate chain. These are SHA-1 encoded strings that act as unique identifiers for the certificates in the chain.
kind	string	Kind defines the object this REST resource represents. (CertificateAuthority)
metadata	object	ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
serial_numbers	array	The serial numbers for each certificate in the certificate chain.
state	string	The current state of the certificate authority. (example: ENABLED)

list_iam_v2_certificate_authorities

Certificate Authority.

Name	Datatype	Description
id	string	ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object kinds or objects of the same kind within a different scope/namespace ("space"). (example: dlz-f3a90de)
display_name	string	The human-readable name of the certificate authority. (example: My Certificate Authority)
api_version	string	APIVersion defines the schema version of this representation of a resource. (iam/v2)
certificate_chain_filename	string	The file name of the uploaded pem file for this certificate authority. (example: certificate.pem)
crl_source	string	The source specifies whether the Certificate Revocation List (CRL) is updated from either local file uploaded (LOCAL) or from url of CRL (URL). (example: LOCAL)
crl_updated_at	string (date-time)	The timestamp for when CRL was last updated. (example: 2017-07-21T17:32:28.000Z)
crl_url	string (uri)	The url from which to fetch the CRL for the certificate authority if crl_source is URL.
description	string	A description of the certificate authority. (example: Sample description text)
expiration_dates	array	The expiration dates of certificates in the chain.
fingerprints	array	The fingerprints for each certificate in the certificate chain. These are SHA-1 encoded strings that act as unique identifiers for the certificates in the chain.
kind	string	Kind defines the object this REST resource represents. (CertificateAuthority)
metadata	object	ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
serial_numbers	array	The serial numbers for each certificate in the certificate chain.
state	string	The current state of the certificate authority. (example: ENABLED)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_iam_v2_certificate_authority	select	id		Make a request to read a certificate authority.
list_iam_v2_certificate_authorities	select		page_size, page_token	Retrieve a sorted, filtered, paginated list of all certificate authorities.
create_iam_v2_certificate_authority	insert			Make a request to create a certificate authority.
update_iam_v2_certificate_authority	replace	id		Make a request to update a certificate authority.
delete_iam_v2_certificate_authority	delete	id		Make a request to delete a certificate authority.

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
id	string	The unique identifier for the certificate authority.
page_size	integer	A pagination size for collection requests.
page_token	string	An opaque pagination token for collection requests.

SELECT examples

get_iam_v2_certificate_authority

Make a request to read a certificate authority.

SELECT
id,
display_name,
api_version,
certificate_chain_filename,
crl_source,
crl_updated_at,
crl_url,
description,
expiration_dates,
fingerprints,
kind,
metadata,
serial_numbers,
state
FROM confluent.iam.certificate_authorities
WHERE id = '{{ id }}' -- required
;

list_iam_v2_certificate_authorities

Retrieve a sorted, filtered, paginated list of all certificate authorities.

SELECT
id,
display_name,
api_version,
certificate_chain_filename,
crl_source,
crl_updated_at,
crl_url,
description,
expiration_dates,
fingerprints,
kind,
metadata,
serial_numbers,
state
FROM confluent.iam.certificate_authorities
WHERE page_size = '{{ page_size }}'
AND page_token = '{{ page_token }}'
;

INSERT examples

create_iam_v2_certificate_authority

Make a request to create a certificate authority.

INSERT INTO confluent.iam.certificate_authorities (
display_name,
description,
certificate_chain,
certificate_chain_filename,
crl_url,
crl_chain
)
SELECT 
'{{ display_name }}',
'{{ description }}',
'{{ certificate_chain }}',
'{{ certificate_chain_filename }}',
'{{ crl_url }}',
'{{ crl_chain }}'
RETURNING
id,
display_name,
api_version,
certificate_chain_filename,
crl_source,
crl_updated_at,
crl_url,
description,
expiration_dates,
fingerprints,
kind,
metadata,
serial_numbers,
state
;

Manifest

# Description fields are for documentation purposes
- name: certificate_authorities
props:
  - name: display_name
    value: "{{ display_name }}"
    description: |
      The human-readable name of the certificate authority.
  - name: description
    value: "{{ description }}"
    description: |
      A description of the certificate authority.
  - name: certificate_chain
    value: "{{ certificate_chain }}"
    description: |
      The PEM encoded string containing the signing certificate chain
      used to validate client certs.
  - name: certificate_chain_filename
    value: "{{ certificate_chain_filename }}"
    description: |
      The name of the certificate file.
  - name: crl_url
    value: "{{ crl_url }}"
    description: |
      The url from which to fetch the CRL for the certificate authority if crl_source is URL.
  - name: crl_chain
    value: "{{ crl_chain }}"
    description: |
      The PEM encoded string containing the CRL for this certificate authority.
      Defaults to this over `crl_url` if available.

REPLACE examples

update_iam_v2_certificate_authority

Make a request to update a certificate authority.

REPLACE confluent.iam.certificate_authorities
SET 
display_name = '{{ display_name }}',
description = '{{ description }}',
certificate_chain = '{{ certificate_chain }}',
certificate_chain_filename = '{{ certificate_chain_filename }}',
crl_url = '{{ crl_url }}',
crl_chain = '{{ crl_chain }}'
WHERE 
id = '{{ id }}' --required
RETURNING
id,
display_name,
api_version,
certificate_chain_filename,
crl_source,
crl_updated_at,
crl_url,
description,
expiration_dates,
fingerprints,
kind,
metadata,
serial_numbers,
state;

DELETE examples

delete_iam_v2_certificate_authority

Make a request to delete a certificate authority.

DELETE FROM confluent.iam.certificate_authorities
WHERE id = '{{ id }}' --required
;