Sign in

v1

latestOpenAPI 3.1.02026-07-2498134321.1 KB
Groups

List all Groups

Documentation on listing Groups via SCIM.

OAuth Scope required: scim.groups.readGroups

get/Groups

Query parameters

startIndexinteger

The starting index for retrieving this resource. Resources are indexed based on when they were first added to Ironclad.

countinteger

Specifies the maximum number of resources to return in a single page of results.

filterstring

Filters for identifying subsets of groups. Filters must comply with the SCIM protocol's convention. For more details, see SCIM RFC 7644 Section 3.4.2.2.

excludedAttributesstring

A comma-separated list of attributes to exclude from the resources in the response.

Headers

x-as-user-emailstring
Example:jane.doe@test.com

Denotes the actor of the request. When used, the API will take into account this user's permissions and access. This or x-as-user-id is required when the associated token was produced from the Client Credentials grant or with legacy bearer tokens on select endpoints. More information about permissions.

x-as-user-idstring
Example:5f0375c4cdc1927a3c5edcd3

Denotes the actor of the request. When used, the API will take into account this user's permissions and access. This or x-as-user-email is required when the associated token was produced from the Client Credentials grant or with legacy bearer tokens on select endpoints. More information about permissions.

Response

200 OK

schemasstring[]
totalResultsinteger

The total number of groups that match this filter. This may be larger than the number of groups in this page, in which case pagination may be used to retrieve the next page of results.

startIndexinteger

The 1-based index of the first result in the current set of list results.

itemsPerPageinteger

Specifies the maximum number of resources that can be returned in a single page of results.

Example response

{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "totalResults": 2,
  "Resources": [
    {
      "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:Group"
      ],
      "displayName": "Legal Ops Group",
      "id": "74906dd6-f2c6-4442-8875-57846f15b061",
      "externalId": "123",
      "members": [
        {
          "type": "User",
          "value": "2bf1bb84-f7ed-4a11-8cbe-138814f9fc21"
        }
      ],
      "meta": {
        "resourceType": "Group",
        "location": "https://na1.ironcladapp.com/scim/v2/Groups/67e4488c605caf0d8aa2e5c6"
      }
    }
  ],
  "startIndex": 1,
  "itemsPerPage": 25
}