user

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

Overview

Name	user
Type	Resource
Id	cloudflare.api_gateway.user

Fields

The following fields are returned by SELECT queries:

get

Retrieve user label response

Name	Datatype	Description
name	string	The name of the label (example: login)
created_at	string (date-time)	(example: 2014-01-01T05:20:00.12345Z)
description	string	The description of the label (example: All endpoints that deal with logins)
last_updated	string (date-time)	(example: 2014-01-01T05:20:00.12345Z)
mapped_resources	object	Provides counts of what resources are linked to this label
metadata	object	Metadata for the label
source	string	* user - label is owned by the user * managed - label is owned by cloudflare (user, managed)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	zone_id, name	with_mapped_resource_counts	Retrieve user label
api_shield_labels_create_user_labels	insert	zone_id
edit	update	zone_id, name		Update certain fields on a label
update	replace	zone_id, name		Update all fields on a label
delete	delete	zone_id, name		Delete user label
api_shield_labels_delete_user_labels	delete	zone_id

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
name	string	Resource name.
zone_id	string	The Cloudflare zone ID.
with_mapped_resource_counts	boolean	Include mapped_resources for each label

SELECT examples

get

Retrieve user label

SELECT
name,
created_at,
description,
last_updated,
mapped_resources,
metadata,
source
FROM cloudflare.api_gateway.user
WHERE zone_id = '{{ zone_id }}' -- required
AND name = '{{ name }}' -- required
AND with_mapped_resource_counts = '{{ with_mapped_resource_counts }}'
;

INSERT examples

api_shield_labels_create_user_labels

No description available.

INSERT INTO cloudflare.api_gateway.user (
zone_id
)
SELECT 
'{{ zone_id }}'
RETURNING
errors,
messages,
result,
result_info,
success
;

Manifest

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

UPDATE examples

edit

Update certain fields on a label

UPDATE cloudflare.api_gateway.user
SET 
description = '{{ description }}',
metadata = '{{ metadata }}'
WHERE 
zone_id = '{{ zone_id }}' --required
AND name = '{{ name }}' --required
RETURNING
errors,
messages,
result,
success;

REPLACE examples

update

Update all fields on a label

REPLACE cloudflare.api_gateway.user
SET 
description = '{{ description }}',
metadata = '{{ metadata }}'
WHERE 
zone_id = '{{ zone_id }}' --required
AND name = '{{ name }}' --required
RETURNING
errors,
messages,
result,
success;

DELETE examples

delete

Delete user label

DELETE FROM cloudflare.api_gateway.user
WHERE zone_id = '{{ zone_id }}' --required
AND name = '{{ name }}' --required
;

api_shield_labels_delete_user_labels

No description available.

DELETE FROM cloudflare.api_gateway.user
WHERE zone_id = '{{ zone_id }}' --required
;