cas

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

Overview

Name	cas
Type	Resource
Id	cloudflare.zero_trust.cas

Fields

The following fields are returned by SELECT queries:

get_by_account

Get a short-lived certificate CA response

Name	Datatype	Description
id	string	The ID of the CA. (example: 7eddae4619b50ab1361ba8ae9bd72269a432fea041529ed9)
aud	string	The Application Audience (AUD) tag. Identifies the application associated with the CA. (example: 737646a56ab1df6ec9bddc7e5ca84eaf3b0768850f3ffb5d74f1534911fe3893)
public_key	string	The public key to add to your SSH server configuration. (example: ecdsa-sha2-nistp256 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/xxxxxxxxxxxxxxxxxxxxx/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx= open-ssh-ca@cloudflareaccess.org)

get_by_zone

Get a short-lived certificate CA response

Name	Datatype	Description
id	string	The ID of the CA. (example: 7eddae4619b50ab1361ba8ae9bd72269a432fea041529ed9)
aud	string	The Application Audience (AUD) tag. Identifies the application associated with the CA. (example: 737646a56ab1df6ec9bddc7e5ca84eaf3b0768850f3ffb5d74f1534911fe3893)
public_key	string	The public key to add to your SSH server configuration. (example: ecdsa-sha2-nistp256 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/xxxxxxxxxxxxxxxxxxxxx/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx= open-ssh-ca@cloudflareaccess.org)

list_by_account

List short-lived certificate CAs response

Name	Datatype	Description
id	string	The ID of the CA. (example: 7eddae4619b50ab1361ba8ae9bd72269a432fea041529ed9)
aud	string	The Application Audience (AUD) tag. Identifies the application associated with the CA. (example: 737646a56ab1df6ec9bddc7e5ca84eaf3b0768850f3ffb5d74f1534911fe3893)
public_key	string	The public key to add to your SSH server configuration. (example: ecdsa-sha2-nistp256 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/xxxxxxxxxxxxxxxxxxxxx/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx= open-ssh-ca@cloudflareaccess.org)

list_by_zone

List short-lived certificate CAs response

Name	Datatype	Description
id	string	The ID of the CA. (example: 7eddae4619b50ab1361ba8ae9bd72269a432fea041529ed9)
aud	string	The Application Audience (AUD) tag. Identifies the application associated with the CA. (example: 737646a56ab1df6ec9bddc7e5ca84eaf3b0768850f3ffb5d74f1534911fe3893)
public_key	string	The public key to add to your SSH server configuration. (example: ecdsa-sha2-nistp256 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/xxxxxxxxxxxxxxxxxxxxx/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx= open-ssh-ca@cloudflareaccess.org)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_by_account	select	app_id, account_id		Fetches a short-lived certificate CA and its public key.
get_by_zone	select	app_id, zone_id		Fetches a short-lived certificate CA and its public key.
list_by_account	select	account_id	page, per_page	Lists short-lived certificate CAs and their public keys.
list_by_zone	select	zone_id	page, per_page	Lists short-lived certificate CAs and their public keys.
create_by_account	insert	app_id, account_id		Generates a new short-lived certificate CA and public key.
create_by_zone	insert	app_id, zone_id		Generates a new short-lived certificate CA and public key.
delete_by_account	delete	app_id, account_id		Deletes a short-lived certificate CA.
delete_by_zone	delete	app_id, zone_id		Deletes a short-lived certificate CA.

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
account_id	string	The Cloudflare account ID.
app_id	string	The Access application ID.
zone_id	string	The Cloudflare zone ID.
page	integer
per_page	integer

SELECT examples

get_by_account

Fetches a short-lived certificate CA and its public key.

SELECT
id,
aud,
public_key
FROM cloudflare.zero_trust.cas
WHERE app_id = '{{ app_id }}' -- required
AND account_id = '{{ account_id }}' -- required
;

get_by_zone

Fetches a short-lived certificate CA and its public key.

SELECT
id,
aud,
public_key
FROM cloudflare.zero_trust.cas
WHERE app_id = '{{ app_id }}' -- required
AND zone_id = '{{ zone_id }}' -- required
;

list_by_account

Lists short-lived certificate CAs and their public keys.

SELECT
id,
aud,
public_key
FROM cloudflare.zero_trust.cas
WHERE account_id = '{{ account_id }}' -- required
AND page = '{{ page }}'
AND per_page = '{{ per_page }}'
;

list_by_zone

Lists short-lived certificate CAs and their public keys.

SELECT
id,
aud,
public_key
FROM cloudflare.zero_trust.cas
WHERE zone_id = '{{ zone_id }}' -- required
AND page = '{{ page }}'
AND per_page = '{{ per_page }}'
;

INSERT examples

create_by_account

Generates a new short-lived certificate CA and public key.

INSERT INTO cloudflare.zero_trust.cas (
app_id,
account_id
)
SELECT 
'{{ app_id }}',
'{{ account_id }}'
RETURNING
errors,
messages,
result,
success
;

create_by_zone

Generates a new short-lived certificate CA and public key.

INSERT INTO cloudflare.zero_trust.cas (
app_id,
zone_id
)
SELECT 
'{{ app_id }}',
'{{ zone_id }}'
RETURNING
errors,
messages,
result,
success
;

Manifest

# Description fields are for documentation purposes
- name: cas
props:
  - name: app_id
    value: "{{ app_id }}"
    description: Required parameter for the cas resource.
  - name: account_id
    value: "{{ account_id }}"
    description: Required parameter for the cas resource.
  - name: zone_id
    value: "{{ zone_id }}"
    description: Required parameter for the cas resource.

DELETE examples

delete_by_account

Deletes a short-lived certificate CA.

DELETE FROM cloudflare.zero_trust.cas
WHERE app_id = '{{ app_id }}' --required
AND account_id = '{{ account_id }}' --required
;

delete_by_zone

Deletes a short-lived certificate CA.

DELETE FROM cloudflare.zero_trust.cas
WHERE app_id = '{{ app_id }}' --required
AND zone_id = '{{ zone_id }}' --required
;