Get group details

GET /Groups/{identifier}

Returns details and members of a specific group

Path parameters

  • identifier string Required

    Identifier of the group to retrieve

Query parameters

  • identifier string

Responses

  • 200 application/scim+json

    OK

    Hide response attributes Show response attributes object
    • meta object | null

      Additional properties are NOT allowed.

      Hide meta attribute Show meta attribute object | null
      • resourceType string | null
    • displayName string | null

      The display name of the group, typically in format 'Organization|Product|Role'

    • members array[object] | null
      Hide members attributes Show members attributes object
      • type string
      • value string

        The identifier of the member

    • id string | null
    • schemas array[string] | null
  • 400 application/scim+json

    Bad Request

    Hide response attributes Show response attributes object
    • type string | null
    • title string | null
    • status integer(int32) | null
    • detail string | null
    • instance string | null
  • 401 application/scim+json

    Unauthorized

    Hide response attributes Show response attributes object
    • type string | null
    • title string | null
    • status integer(int32) | null
    • detail string | null
    • instance string | null
  • 403 application/scim+json

    Forbidden

    Hide response attributes Show response attributes object
    • type string | null
    • title string | null
    • status integer(int32) | null
    • detail string | null
    • instance string | null
  • 404

    Group not found

  • 500 application/scim+json

    Internal Server Error

    Hide response attributes Show response attributes object
    • type string | null
    • title string | null
    • status integer(int32) | null
    • detail string | null
    • instance string | null
  • 501 application/scim+json

    Not Implemented

    Hide response attributes Show response attributes object
    • type string | null
    • title string | null
    • status integer(int32) | null
    • detail string | null
    • instance string | null
GET /Groups/{identifier}
curl \
 --request GET 'https://setup.adra.com/api/organizations/{organizationSid}/scim/Groups/{identifier}' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200)
{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "meta": {
    "resourceType": "Group"
  },
  "members": [
    {
      "value": "9876fedc-ba09-8765-4321-0fedcba98765",
      "display": "John Smith"
    }
  ],
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:Group"
  ],
  "displayName": "Ortiz and Sons|Balancer|User"
}
Response examples (400)
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (401)
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (403)
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (500)
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (501)
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}