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

The people the identity provider has pushed, or the one a `userName eq` filter names.

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

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

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

Parameters

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

Responses

200A page of usersapplication/json
  • itemsPerPageinteger · int64
  • Resourcesarray of ScimUser
    • The ScimUser schema
    • userNamestringThe person's sign-in name — for gitmoap, their email address.
    • activebooleanoptionalfalse takes away the person's access to the organization; true gives it back.
    • displayNamestring or nulloptional
    • emailsarray of ScimEmailoptional
    • externalIdstring or nulloptional
    • groupsarray of ScimMemberRefoptionalThe groups the person is in. Read-only: groups are changed through the group.
    • idstring or nulloptional
    • metaScimMeta or nulloptional
      • The ScimMeta schema
      • createdstring · date-time
      • lastModifiedstring · date-time
      • locationstring
      • resourceTypestring
    • nameScimName or nulloptional
      • The ScimName schema
      • familyNamestring or nulloptional
      • formattedstring or nulloptional
      • givenNamestring or nulloptional
    • schemasarray of stringoptional
  • schemasarray of string
  • startIndexinteger · int64
  • totalResultsinteger · int64
200 exampleSynthesized example
{
"itemsPerPage": 31,
"Resources": [
{
"userName": "userName-14ca"
},
{
"userName": "userName-b865"
}
],
"schemas": [
"schemas-ba60"
],
"startIndex": 77,
"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-371f",
"schemas": [
"schemas-a88d",
"schemas-7eb1"
],
"status": "status-ae48"
}
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-fb33",
"schemas": [
"schemas-8006",
"schemas-cbeb"
],
"status": "status-2b42"
}

CLI

gitmoap scim list-scim-users

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

Used in these guides