Get a group by ID

Can be used by the following roles assigned at the organization scope:

• ORG_ADMIN

GET /api/scim/v2/Groups/{id}

cURL

cURL

curl --request GET \
  --url https://cockroachlabs.cloud/api/scim/v2/Groups/{id} \
  --header 'Authorization: Bearer <token>'

200

{
  "displayName": "<string>",
  "id": "<string>",
  "schemas": [
    "<string>"
  ],
  "externalId": "<string>",
  "members": [
    {
      "display": "<string>",
      "ref": "<string>",
      "type": "<string>",
      "value": "<string>"
    }
  ],
  "meta": {
    "created": "<string>",
    "lastModified": "<string>",
    "location": "<string>",
    "resourceType": "<string>"
  }
}

{
  "code": 123,
  "details": [
    {
      "@type": "<string>"
    }
  ],
  "message": "<string>"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id · string · required

Query Parameters

attributes · string

excludedAttributes · string

Response

200

application/json

A successful response.

SCIM 2.0 Group Resource

displayName · string · required

id · string · required

schemas · string[] · required

externalId · string

members · SCIM · object[]

Show child attributes

meta · meta · object

Show child attributes