sso

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

Overview

Name	sso
Type	Resource
Id	cloudflare.iam.sso

Fields

The following fields are returned by SELECT queries:

get

Get SSO connector response

Name	Datatype	Description
id	string	SSO Connector identifier tag. (title: SSO Connector Identifier, example: 023e105f4ecef8ad9ca31a8372d0c353)
created_on	string (date-time)	Timestamp for the creation of the SSO connector (example: 2025-01-01T12:21:02.0000Z)
email_domain	string	(example: example.com)
enabled	boolean
updated_on	string (date-time)	Timestamp for the last update of the SSO connector (example: 2025-01-01T12:21:02.0000Z)
use_fedramp_language	boolean	Controls the display of FedRAMP language to the user during SSO login (x-stainless-terraform-configurability: computed_optional)
verification	object

list

Get all SSO connectors response

Name	Datatype	Description
id	string	SSO Connector identifier tag. (title: SSO Connector Identifier, example: 023e105f4ecef8ad9ca31a8372d0c353)
created_on	string (date-time)	Timestamp for the creation of the SSO connector (example: 2025-01-01T12:21:02.0000Z)
email_domain	string	(example: example.com)
enabled	boolean
updated_on	string (date-time)	Timestamp for the last update of the SSO connector (example: 2025-01-01T12:21:02.0000Z)
use_fedramp_language	boolean	Controls the display of FedRAMP language to the user during SSO login (x-stainless-terraform-configurability: computed_optional)
verification	object

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	account_id, sso_connector_id
list	select	account_id
begin_verification	insert	account_id, sso_connector_id
create	insert	account_id, email_domain
update	update	account_id, sso_connector_id
delete	delete	account_id, sso_connector_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
account_id	string	The Cloudflare account ID.
sso_connector_id	string

SELECT examples

get

Get SSO connector response

SELECT
id,
created_on,
email_domain,
enabled,
updated_on,
use_fedramp_language,
verification
FROM cloudflare.iam.sso
WHERE account_id = '{{ account_id }}' -- required
AND sso_connector_id = '{{ sso_connector_id }}' -- required
;

list

Get all SSO connectors response

SELECT
id,
created_on,
email_domain,
enabled,
updated_on,
use_fedramp_language,
verification
FROM cloudflare.iam.sso
WHERE account_id = '{{ account_id }}' -- required
;

INSERT examples

begin_verification

No description available.

INSERT INTO cloudflare.iam.sso (
account_id,
sso_connector_id
)
SELECT 
'{{ account_id }}',
'{{ sso_connector_id }}'
RETURNING
errors,
messages,
success
;

create

No description available.

INSERT INTO cloudflare.iam.sso (
begin_verification,
email_domain,
use_fedramp_language,
account_id
)
SELECT 
{{ begin_verification }},
'{{ email_domain }}' /* required */,
{{ use_fedramp_language }},
'{{ account_id }}'
RETURNING
errors,
messages,
result,
success
;

Manifest

# Description fields are for documentation purposes
- name: sso
props:
  - name: account_id
    value: "{{ account_id }}"
    description: Required parameter for the sso resource.
  - name: sso_connector_id
    value: "{{ sso_connector_id }}"
    description: Required parameter for the sso resource.
  - name: begin_verification
    value: {{ begin_verification }}
    description: |
      Begin the verification process after creation
    default: true
  - name: email_domain
    value: "{{ email_domain }}"
    description: |
      Email domain of the new SSO connector
  - name: use_fedramp_language
    value: {{ use_fedramp_language }}
    description: |
      Controls the display of FedRAMP language to the user during SSO login
    default: false

UPDATE examples

update

No description available.

UPDATE cloudflare.iam.sso
SET 
enabled = {{ enabled }},
use_fedramp_language = {{ use_fedramp_language }}
WHERE 
account_id = '{{ account_id }}' --required
AND sso_connector_id = '{{ sso_connector_id }}' --required
RETURNING
errors,
messages,
result,
success;

DELETE examples

delete

No description available.

DELETE FROM cloudflare.iam.sso
WHERE account_id = '{{ account_id }}' --required
AND sso_connector_id = '{{ sso_connector_id }}' --required
;