configuration

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

Overview

Name	configuration
Type	Resource
Id	cloudflare.token_validation.configuration

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	UUID. (example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415)
created_at	string (date-time)	(example: 2014-01-01T05:20:00.12345Z)
credentials	object
description	string	(example: Long description for Token Validation Configuration)
last_updated	string (date-time)	(example: 2014-01-01T05:20:00.12345Z)
title	string	(example: Example Token Validation Configuration)
token_sources	array
token_type	string	(JWT) (example: JWT)

list

Name	Datatype	Description
id	string	UUID. (example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415)
created_at	string (date-time)	(example: 2014-01-01T05:20:00.12345Z)
credentials	object
description	string	(example: Long description for Token Validation Configuration)
last_updated	string (date-time)	(example: 2014-01-01T05:20:00.12345Z)
title	string	(example: Example Token Validation Configuration)
token_sources	array
token_type	string	(JWT) (example: JWT)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	zone_id, config_id		Get a single Token Configuration
list	select	zone_id	page, per_page	Lists all token validation configurations for this zone
create	insert	zone_id, title, description, token_sources, token_type, credentials		Create a new Token Validation configuration
edit	update	zone_id, config_id		Edit fields of an existing Token Configuration
delete	delete	zone_id, config_id		Delete Token Configuration

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
config_id	string	Token Configuration ID
zone_id	string	The Cloudflare zone ID.
page	integer	Page number of paginated results.
per_page	integer	Maximum number of results per page.

SELECT examples

get

Get a single Token Configuration

SELECT
id,
created_at,
credentials,
description,
last_updated,
title,
token_sources,
token_type
FROM cloudflare.token_validation.configuration
WHERE zone_id = '{{ zone_id }}' -- required
AND config_id = '{{ config_id }}' -- required
;

list

Lists all token validation configurations for this zone

SELECT
id,
created_at,
credentials,
description,
last_updated,
title,
token_sources,
token_type
FROM cloudflare.token_validation.configuration
WHERE zone_id = '{{ zone_id }}' -- required
AND page = '{{ page }}'
AND per_page = '{{ per_page }}'
;

INSERT examples

create

Create a new Token Validation configuration

INSERT INTO cloudflare.token_validation.configuration (
credentials,
description,
title,
token_sources,
token_type,
zone_id
)
SELECT 
'{{ credentials }}' /* required */,
'{{ description }}' /* required */,
'{{ title }}' /* required */,
'{{ token_sources }}' /* required */,
'{{ token_type }}' /* required */,
'{{ zone_id }}'
RETURNING
errors,
messages,
result,
success
;

Manifest

# Description fields are for documentation purposes
- name: configuration
props:
  - name: zone_id
    value: "{{ zone_id }}"
    description: Required parameter for the configuration resource.
  - name: credentials
    value:
      keys:
        - kid: "{{ kid }}"
          alg: "{{ alg }}"
          e: "{{ e }}"
          kty: "{{ kty }}"
          n: "{{ n }}"
          x: "{{ x }}"
          y: "{{ y }}"
          crv: "{{ crv }}"
  - name: description
    value: "{{ description }}"
  - name: title
    value: "{{ title }}"
  - name: token_sources
    value:
      - "{{ token_sources }}"
  - name: token_type
    value: "{{ token_type }}"
    valid_values: ['JWT']

UPDATE examples

edit

Edit fields of an existing Token Configuration

UPDATE cloudflare.token_validation.configuration
SET 
description = '{{ description }}',
title = '{{ title }}',
token_sources = '{{ token_sources }}'
WHERE 
zone_id = '{{ zone_id }}' --required
AND config_id = '{{ config_id }}' --required
RETURNING
errors,
messages,
result,
success;

DELETE examples

delete

Delete Token Configuration

DELETE FROM cloudflare.token_validation.configuration
WHERE zone_id = '{{ zone_id }}' --required
AND config_id = '{{ config_id }}' --required
;