Skip to content
GitmoapAPIBeta
Identity & platformscim
GET/scim/v2/organizations/{group_id}/Groups

The teams the identity provider keeps, or the one a `displayName eq` filter names.

list_scim_groups
  • Public
    This operation declares no security requirement: it takes no token.
  • Single-resource

    x-gitmoap-isolation: {"kind":"single_or_self_scoped"}

Only the teams of the organization the SCIM token belongs to.

Parameters

Path
  • group_idGroupId (string · uuid)The organization's top-level group
Query
  • filterstringoptionaldisplayName eq "…"
  • startIndexinteger · int64optional1-based index of the first result
  • countinteger · int64optionalResults per page, at most 100

Responses

200A page of groupsapplication/json
  • itemsPerPageinteger · int64
  • Resourcesarray of ScimGroup
    • The ScimGroup schema
    • displayNamestring
    • externalIdstring or nulloptional
    • idstring or nulloptional
    • membersarray of ScimMemberRefoptional
    • metaScimMeta or nulloptional
      • The ScimMeta schema
      • createdstring · date-time
      • lastModifiedstring · date-time
      • locationstring
      • resourceTypestring
    • schemasarray of stringoptional
  • schemasarray of string
  • startIndexinteger · int64
  • totalResultsinteger · int64
200 exampleSynthesized example
{
"itemsPerPage": 3,
"Resources": [
{
"displayName": "displayName-04a6"
},
{
"displayName": "displayName-3f70"
}
],
"schemas": [
"schemas-107e",
"schemas-d763"
],
"startIndex": 24,
"totalResults": 1
}
400An unsupported filterapplication/json
Error codes
  • BAD_REQUESTThe request is malformed: a parameter or a body field is not a well-formed value of its type
  • detailstring
  • schemasarray of string
  • statusstringThe HTTP status code, written as text, as the SCIM protocol requires.
  • scimTypestring or nulloptional
400 exampleSynthesized example
{
"detail": "detail-8a43",
"schemas": [
"schemas-0443",
"schemas-6ccc"
],
"status": "status-9eee"
}
401No valid SCIM token of this organizationapplication/json
Error codes
  • UNAUTHORIZEDNo credential was sent, or the one sent is invalid, expired or revoked
  • detailstring
  • schemasarray of string
  • statusstringThe HTTP status code, written as text, as the SCIM protocol requires.
  • scimTypestring or nulloptional
401 exampleSynthesized example
{
"detail": "detail-bce0",
"schemas": [
"schemas-0f81",
"schemas-d83a"
],
"status": "status-44c3"
}

CLI

gitmoap scim list-scim-groups

  • --group-ididThe organization's top-level group (id or group path)
  • --countnumberoptionalResults per page, at most 100
  • --filterstringoptional`displayName eq "…"`
  • --start-indexnumberoptional

Used in these guides