zt_risk_scoring_integrations

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

Overview

Name	zt_risk_scoring_integrations
Type	Resource
Id	cloudflare.zero_trust.zt_risk_scoring_integrations

Fields

The following fields are returned by SELECT queries:

get

Get response.

Name	Datatype	Description
id	string (uuid)	The id of the integration, a UUIDv4.
reference_id	string	A reference ID defined by the client. Should be set to the Access-Okta IDP integration ID. Useful when the risk-score integration needs to be associated with a secondary asset and recalled using that ID.
account_tag	string	The Cloudflare account tag.
active	boolean	Whether this integration is enabled and should export changes in risk score.
created_at	string (date-time)	When the integration was created in RFC3339 format.
integration_type	string	(Okta)
tenant_url	string	The base URL for the tenant. E.g. "https://tenant.okta.com".
well_known_url	string	The URL for the Shared Signals Framework configuration, e.g. "/.well-known/sse-configuration/{integration_uuid}/". https://openid.net/specs/openid-sse-framework-1_0.html#rfc.section.6.2.1.

list

List response.

Name	Datatype	Description
id	string (uuid)	The id of the integration, a UUIDv4.
reference_id	string	A reference ID defined by the client. Should be set to the Access-Okta IDP integration ID. Useful when the risk-score integration needs to be associated with a secondary asset and recalled using that ID.
account_tag	string	The Cloudflare account tag.
active	boolean	Whether this integration is enabled and should export changes in risk score.
created_at	string (date-time)	When the integration was created in RFC3339 format.
integration_type	string	(Okta)
tenant_url	string	The base URL for the tenant. E.g. "https://tenant.okta.com".
well_known_url	string	The URL for the Shared Signals Framework configuration, e.g. "/.well-known/sse-configuration/{integration_uuid}/". https://openid.net/specs/openid-sse-framework-1_0.html#rfc.section.6.2.1.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	account_id, integration_id
list	select	account_id		Lists all configured Zero Trust risk score integrations for the account.
create	insert	account_id, integration_type, tenant_url		Creates a new Zero Trust risk score integration, connecting external risk signals to Cloudflare's risk scoring system.
delete	delete	account_id, integration_id		Removes a Zero Trust risk score integration, disconnecting the external risk signal source.

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.
integration_id	string (uuid)

SELECT examples

get

Get response.

SELECT
id,
reference_id,
account_tag,
active,
created_at,
integration_type,
tenant_url,
well_known_url
FROM cloudflare.zero_trust.zt_risk_scoring_integrations
WHERE account_id = '{{ account_id }}' -- required
AND integration_id = '{{ integration_id }}' -- required
;

list

Lists all configured Zero Trust risk score integrations for the account.

SELECT
id,
reference_id,
account_tag,
active,
created_at,
integration_type,
tenant_url,
well_known_url
FROM cloudflare.zero_trust.zt_risk_scoring_integrations
WHERE account_id = '{{ account_id }}' -- required
;

INSERT examples

create

Creates a new Zero Trust risk score integration, connecting external risk signals to Cloudflare's risk scoring system.

INSERT INTO cloudflare.zero_trust.zt_risk_scoring_integrations (
integration_type,
reference_id,
tenant_url,
account_id
)
SELECT 
'{{ integration_type }}' /* required */,
'{{ reference_id }}',
'{{ tenant_url }}' /* required */,
'{{ account_id }}'
RETURNING
errors,
messages,
result,
success
;

Manifest

# Description fields are for documentation purposes
- name: zt_risk_scoring_integrations
props:
  - name: account_id
    value: "{{ account_id }}"
    description: Required parameter for the zt_risk_scoring_integrations resource.
  - name: integration_type
    value: "{{ integration_type }}"
    valid_values: ['Okta']
  - name: reference_id
    value: "{{ reference_id }}"
    description: |
      A reference id that can be supplied by the client. Currently this should be set to the Access-Okta IDP ID (a UUIDv4). https://developers.cloudflare.com/api/operations/access-identity-providers-get-an-access-identity-provider
  - name: tenant_url
    value: "{{ tenant_url }}"
    description: |
      The base url of the tenant, e.g. "https://tenant.okta.com".

DELETE examples

delete

Removes a Zero Trust risk score integration, disconnecting the external risk signal source.

DELETE FROM cloudflare.zero_trust.zt_risk_scoring_integrations
WHERE account_id = '{{ account_id }}' --required
AND integration_id = '{{ integration_id }}' --required
;