categories

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

Overview

Name	categories
Type	Resource
Id	cloudflare.cloudforce_one.categories

Fields

The following fields are returned by SELECT queries:

get

Returns a category.

Name	Datatype	Description
name	string
killChain	number
mitreAttack	array
mitreCapec	array
shortname	string
uuid	string

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	account_id, category_id
post_category_update	insert	account_id, category_id
edit	update	account_id, category_id
patch_tag_category_update	update	account_id, category_uuid		Updates a Source-of-Truth tag category by UUID.
delete	delete	account_id, category_id
delete_tag_category_delete	delete	account_id, category_uuid		Deletes a Source-of-Truth tag category by UUID.

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.
category_id	string (uuid)	Category UUID.
category_uuid	string	Tag Category UUID.

SELECT examples

get

Returns a category.

SELECT
name,
killChain,
mitreAttack,
mitreCapec,
shortname,
uuid
FROM cloudflare.cloudforce_one.categories
WHERE account_id = '{{ account_id }}' -- required
AND category_id = '{{ category_id }}' -- required
;

INSERT examples

post_category_update

No description available.

INSERT INTO cloudflare.cloudforce_one.categories (
killChain,
mitreAttack,
mitreCapec,
name,
shortname,
account_id,
category_id
)
SELECT 
{{ killChain }},
'{{ mitreAttack }}',
'{{ mitreCapec }}',
'{{ name }}',
'{{ shortname }}',
'{{ account_id }}',
'{{ category_id }}'
RETURNING
name,
killChain,
mitreAttack,
mitreCapec,
shortname,
uuid
;

Manifest

# Description fields are for documentation purposes
- name: categories
props:
  - name: account_id
    value: "{{ account_id }}"
    description: Required parameter for the categories resource.
  - name: category_id
    value: "{{ category_id }}"
    description: Required parameter for the categories resource.
  - name: killChain
    value: {{ killChain }}
  - name: mitreAttack
    value:
      - "{{ mitreAttack }}"
  - name: mitreCapec
    value:
      - "{{ mitreCapec }}"
  - name: name
    value: "{{ name }}"
  - name: shortname
    value: "{{ shortname }}"

UPDATE examples

edit

No description available.

UPDATE cloudflare.cloudforce_one.categories
SET 
killChain = {{ killChain }},
mitreAttack = '{{ mitreAttack }}',
mitreCapec = '{{ mitreCapec }}',
name = '{{ name }}',
shortname = '{{ shortname }}'
WHERE 
account_id = '{{ account_id }}' --required
AND category_id = '{{ category_id }}' --required
RETURNING
name,
killChain,
mitreAttack,
mitreCapec,
shortname,
uuid;

patch_tag_category_update

Updates a Source-of-Truth tag category by UUID.

UPDATE cloudflare.cloudforce_one.categories
SET 
description = '{{ description }}',
name = '{{ name }}'
WHERE 
account_id = '{{ account_id }}' --required
AND category_uuid = '{{ category_uuid }}' --required
RETURNING
name,
createdAt,
description,
updatedAt,
uuid;

DELETE examples

delete

No description available.

DELETE FROM cloudflare.cloudforce_one.categories
WHERE account_id = '{{ account_id }}' --required
AND category_id = '{{ category_id }}' --required
;

delete_tag_category_delete

Deletes a Source-of-Truth tag category by UUID.

DELETE FROM cloudflare.cloudforce_one.categories
WHERE account_id = '{{ account_id }}' --required
AND category_uuid = '{{ category_uuid }}' --required
;