List SCIM Group resources

client.zeroTrust.identityProviders.scim.groups.list(, , ?): V4PagePaginationArray<ZeroTrustGroup { id, displayName, externalId, 2 more } >

GET/accounts/{account_id}/access/identity_providers/{identity_provider_id}/scim/groups

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

Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

Accepted Permissions (at least one required)

Access: Organizations, Identity Providers, and Groups WriteAccess: Organizations, Identity Providers, and Groups Read

ParametersExpand Collapse

identityProviderId: string

UUID.

maxLength36

params: GroupListParams { account_id, cf_resource_id, idp_resource_id, 3 more }

account_id: string

Path param: Identifier.

maxLength32

cf_resource_id?: Array<string>

Query param: The unique Cloudflare-generated Id of the SCIM Group resource; also known as the “Id”. Pass once for a single lookup (?cf_resource_id=A) or repeat the parameter (?cf_resource_id=A&cf_resource_id=B) to look up multiple groups in one request, up to 50 values. Mutually exclusive with idp_resource_id, name, search_contains, and search_starts_with.

idp_resource_id?: Array<string>

Query param: The IdP-generated Id of the SCIM Group resource; also known as the “external Id”. Pass once for a single lookup (?idp_resource_id=A) or repeat the parameter (?idp_resource_id=A&idp_resource_id=B) to look up multiple groups in one request, up to 50 values. Mutually exclusive with cf_resource_id, name, search_contains, and search_starts_with.

name?: string

Query param: The display name of the SCIM Group resource.

page?: number

Query param: Page number of results.

per_page?: number

Query param: Number of results per page.

ReturnsExpand Collapse

ZeroTrustGroup { id, displayName, externalId, 2 more }

id?: string

The unique Cloudflare-generated Id of the SCIM resource.

displayName?: string

The display name of the SCIM Group resource.

externalId?: string

The IdP-generated Id of the SCIM resource.

meta?: Meta { created, lastModified }

The metadata of the SCIM resource.

created?: string

The timestamp of when the SCIM resource was created.

formatdate-time

lastModified?: string

The timestamp of when the SCIM resource was last modified.

formatdate-time

schemas?: Array<string>

The list of URIs which indicate the attributes contained within a SCIM resource.

List SCIM Group resources

import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const zeroTrustGroup of client.zeroTrust.identityProviders.scim.groups.list(
  'f174e90a-fafe-4643-bbbc-4a0ed4fc8415',
  { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
)) {
  console.log(zeroTrustGroup.id);
}

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": [
    {
      "id": "bd97ef8d-7986-43e3-9ee0-c25dda33e4b0",
      "displayName": "ALL EMPLOYEES",
      "externalId": "all_employees",
      "meta": {
        "created": "2025-01-01T00:00:00Z",
        "lastModified": "2025-01-02T00:00:00Z"
      },
      "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:Group"
      ]
    }
  ],
  "result_info": {
    "count": 1,
    "page": 1,
    "per_page": 20,
    "total_count": 2000,
    "total_pages": 100
  }
}

Returns Examples

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": [
    {
      "id": "bd97ef8d-7986-43e3-9ee0-c25dda33e4b0",
      "displayName": "ALL EMPLOYEES",
      "externalId": "all_employees",
      "meta": {
        "created": "2025-01-01T00:00:00Z",
        "lastModified": "2025-01-02T00:00:00Z"
      },
      "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:Group"
      ]
    }
  ],
  "result_info": {
    "count": 1,
    "page": 1,
    "per_page": 20,
    "total_count": 2000,
    "total_pages": 100
  }
}