v1

latestOpenAPI 3.0.1Apache 2.02026-07-1398228598.3 KB
Scim
Group

List SCIM Groups

Retrieves a list of groups, supports filtering and pagination. Used by SCIM clients like Okta.

get/scim/Groups

Query parameters

startIndexinteger

The 1-based index of the first result

countinteger

Desired maximum number of query results per page

Response

User list retrieved successfully

schemasstring[] required
totalResultsinteger required
startIndexinteger required
itemsPerPageinteger required

Example response

{
  "totalResults": 2,
  "startIndex": 1,
  "itemsPerPage": 2,
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:Group"
  ],
  "Resources": [
    {
      "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:Group",
        "urn:okta:custom:group:1.0"
      ],
      "displayName": "firstGroup",
      "id": "1001",
      "members": [
        {
          "value": "101",
          "display": "okta"
        }
      ],
      "urn:okta:custom:group:1.0": {
        "description": "This is the first group"
      }
    },
    {
      "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:Group"
      ],
      "displayName": "secondGroup",
      "id": "1002",
      "members": [
        {
          "value": "101",
          "display": "okta"
        },
        {
          "value": "102",
          "display": "admin"
        }
      ]
    }
  ]
}