List provisioned SCIM groups for an enterprise

GET

/scim/v2/enterprises/{enterprise}/Groups

Note: The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.github.com/scim/v2/enterprises//Groups'

Response Example

{
    "Resources": [
        {
            "displayName": "string",
            "externalId": "string",
            "id": "string",
            "members": [
                {
                    "$ref": "string",
                    "display": "string",
                    "value": "string"
                }
            ],
            "meta": {
                "created": "string",
                "lastModified": "string",
                "location": "string",
                "resourceType": "string"
            },
            "schemas": [
                "string"
            ]
        }
    ],
    "itemsPerPage": 0,
    "schemas": [
        "string"
    ],
    "startIndex": 0,
    "totalResults": 0
}

Request

Path Params

enterprise

string

required

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

Query Params

startIndex

integer

optional

Used for pagination: the index of the first result to return.

count

integer

optional

Used for pagination: the number of results to return.

filter

string

optional

filter results

excludedAttributes

string

optional

attributes to exclude

Responses

🟢200response

application/json

Body

Resources

array [object {6}]

required

displayName

string

optional

externalId

string | null

optional

string

required

members

array [object {3}]

optional