Set SCIM information for a provisioned enterprise group

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

Replaces an existing provisioned group’s information. You must provide all the information required for the group as if you were provisioning it for the first time. Any existing group information that you don't provide will be removed, including group membership. If you want to only update a specific attribute, use the Update an attribute for a SCIM enterprise group endpoint instead.

curl --location --request PUT 'https://api.github.com/scim/v2/enterprises//Groups/' \ --header 'Content-Type: application/json' \ --data-raw '{ "displayName": "octo-org", "members": [ { "value": "92b58aaa-a1d6-11ea-8227-b9ce9e023ccc" }, { "value": "aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5" } ], "schemas": [ "urn:ietf:params:scim:schemas:core:2.0:Group" ] }'

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

Request

Path Params

enterprise

string

required

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

scim_group_id

string

required

Identifier generated by the GitHub SCIM endpoint.

Body Params application/json

displayName

string

required

The name of the SCIM group. This must match the GitHub organization that the group maps to.

members

array [object {1}]

optional

value

string

required

The SCIM user ID for a user.

schemas

array[string]

required

The SCIM schema URIs.

Examples

Responses

🟢200response

application/json

Body

displayName

string

optional

externalId

string | null

optional

string

required

members

array [object {3}]

optional

$ref

string

optional

display

string

optional

value

string

optional