scim_groups

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

Overview

Name	scim_groups
Type	Resource
Id	cloudflare.zero_trust.scim_groups

Fields

The following fields are returned by SELECT queries:

list_by_account

List SCIM Group resources response

Name	Datatype	Description
id	string	The unique Cloudflare-generated Id of the SCIM resource. (example: bd97ef8d-7986-43e3-9ee0-c25dda33e4b0)
displayName	string	The display name of the SCIM Group resource. (example: ALL EMPLOYEES)
externalId	string	The IdP-generated Id of the SCIM resource. (example: all_employees)
meta	object	The metadata of the SCIM resource.
schemas	array	The list of URIs which indicate the attributes contained within a SCIM resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_by_account	select	identity_provider_id, account_id	cf_resource_id, idp_resource_id, name, page, per_page	Lists SCIM Group resources synced to Cloudflare via the System for Cross-domain Identity Management (SCIM).

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.
identity_provider_id	string
cf_resource_id	string
idp_resource_id	string
name	string
page	integer
per_page	integer

SELECT examples

list_by_account

Lists SCIM Group resources synced to Cloudflare via the System for Cross-domain Identity Management (SCIM).

SELECT
id,
displayName,
externalId,
meta,
schemas
FROM cloudflare.zero_trust.scim_groups
WHERE identity_provider_id = '{{ identity_provider_id }}' -- required
AND account_id = '{{ account_id }}' -- required
AND cf_resource_id = '{{ cf_resource_id }}'
AND idp_resource_id = '{{ idp_resource_id }}'
AND name = '{{ name }}'
AND page = '{{ page }}'
AND per_page = '{{ per_page }}'
;