List SCIM Groups

List SCIM groups with RFC 7644 semantics.

GET /scim/v2/Groups

Try it

List SCIM Groups

cURL

curl --request GET \
  --url https://paradigm.lighton.ai/scim/v2/Groups \
  --header 'Authorization: Bearer <token>'

200

{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "totalResults": 1,
  "startIndex": 1,
  "itemsPerPage": 50,
  "Resources": [
    {
      "$ref": "#/components/examples/SCIMGroupEngineering/value"
    }
  ]
}

Authorizations

Authorization · string · header · required

Bearer token authentication

Query Parameters

filter · string

SCIM filter expression (RFC 7644 §3.4.2.2), e.g. userName eq "alice", emails.value co "example.com". Operators: eq, ne, co, sw, ew, gt, ge, lt, le, pr. Group with and/or/not. Use parentheses to control precedence.

startIndex · integer · default: 1

1-based index of first result (default 1).

Required range: x >= 1

count · integer · default: 50

Page size / number of results to return (server may cap).

Required range: 0 <= x <= 200

sortBy · string

Attribute name to sort by (e.g., userName, displayName).

sortOrder · enum<string> · default: ascending

Sort order direction.

Available options: ascending, descending

attributes · string

Comma-separated attribute paths to include in the response.

excludedAttributes · string

Comma-separated attribute paths to exclude from the response.

Response

200

application/json

SCIM ListResponse of Groups

schemas · string[] · required

Example:

[
  "urn:ietf:params:scim:api:messages:2.0:ListResponse"
]

totalResults · integer · required

Example:

1

startIndex · integer · required

Example:

1

itemsPerPage · integer · required

Example:

50

Resources · object[] · required

Option 1

Option 2

Show child attributes

Resources. schemas · string[] · required

Resources. userName · string · required

Example:

"alice"

Resources. id · string

Example:

"2819c223-7f76-453a-919d-413861904646"

Resources. externalId · string

Identifier from the provisioning system (idempotency key)

Resources. name · object

Show child attributes

Resources.name. givenName · string

Resources.name. familyName · string

Resources.name. middleName · string

Resources.name. formatted · string

Resources.name. honorificPrefix · string

Resources.name. honorificSuffix · string

Resources. displayName · string

Resources. nickName · string

Resources. profileUrl · string<uri>

Resources. emails · object[]

Show child attributes

Resources.emails. value · string<email>

Resources.emails. type · string

Example:

"work"

Resources.emails. primary · boolean

Resources. phoneNumbers · object[]

Show child attributes

Resources.phoneNumbers. value · string

Resources.phoneNumbers. type · string

Example:

"work"

Resources. active · boolean · default: true

Resources. groups · object[]

Show child attributes

Resources.groups. type · any

Resources.groups. example · any

Resources.groups. value · string

Group id

Resources.groups. display · string

Resources. meta · object

Show child attributes

Resources.meta. resourceType · string

Example:

"User"

Resources.meta. created · string<date-time>

Resources.meta. lastModified · string<date-time>

Resources.meta. location · string

Example:

"/scim/v2/Users/2819c223-..."

Resources.meta. version · string

Example:

"W/\"a330bc54f0671c9\""