schemas
Creates, updates, deletes, gets or lists a schemas resource.
Overview
| Name | schemas |
| Type | Resource |
| Id | cloudflare.iam.schemas |
Fields
The following fields are returned by SELECT queries:
- get
- list
Get SCIM Schema response
| Name | Datatype | Description |
|---|---|---|
contents | string |
List SCIM Schemas response
| Name | Datatype | Description |
|---|---|---|
contents | string |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | account_id, schema_id | Returns a single SCIM schema definition by schema URI ID (RFC 7643 Section 7). Valid IDs are urn:ietf:params:scim:schemas:core:2.0:User and urn:ietf:params:scim:schemas:core:2.0:Group. | |
list | select | account_id | Returns the list of SCIM schemas supported by the Cloudflare SCIM service (RFC 7643 Section 7, RFC 7644 Section 4). Clients use this to introspect the attributes of each resource type. Query parameters are not supported on this endpoint. |
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. |
schema_id | string |
SELECT examples
- get
- list
Returns a single SCIM schema definition by schema URI ID (RFC 7643 Section 7). Valid IDs are urn:ietf:params:scim:schemas:core:2.0:User and urn:ietf:params:scim:schemas:core:2.0:Group.
SELECT
contents
FROM cloudflare.iam.schemas
WHERE account_id = '{{ account_id }}' -- required
AND schema_id = '{{ schema_id }}' -- required
;
Returns the list of SCIM schemas supported by the Cloudflare SCIM service (RFC 7643 Section 7, RFC 7644 Section 4). Clients use this to introspect the attributes of each resource type. Query parameters are not supported on this endpoint.
SELECT
contents
FROM cloudflare.iam.schemas
WHERE account_id = '{{ account_id }}' -- required
;