GIgitguardian
SCIM Groups

Update a group (SCIM)

Update a group (team in GIM) using the SCIM Protocol.

put/v1/scim/v2/Groups/{id}

Request

  • Base URL
    https://api.gitguardian.com
  • URL
    https://api.gitguardian.com/v1/scim/v2/Groups/{id}
  • Auth
    HTTP bearer

Path parameters

idstring required

The identifier of the group. To comply with the SCIM unique identifier rule we use the team ID prefixed by 'group-'. e.g 'group-123456'

Request body

schemasstring[]
externalIdstring

Unique identifier used by the Identity Provider for this resource.

displayNamestring required

A human-readable name for the Group. Should be unique within the workspace.

descriptionstring

A human-readable description for the Group.

Example request

{
  "members": [
    {
      "value": "123456",
      "$ref": "https://api.gitguardian.com/v1/scim/v2/Users/123456"
    }
  ]
}

Response

Group Detail

schemasstring[]

the namespaces of the SCIM schemas that define the attributes present in the current JSON structure.

idstring

The unique identifier used in GIM for this resource (team ID prefixed by 'group-').

externalIdstring

The unique identifier used by the provisioning client for this resource.

displayNamestring

A human-readable name for the Group. Should be unique within the workspace.

descriptionstring

A human-readable description for the Group.

Example response

{
  "id": "group-123456",
  "externalId": "123-456-789",
  "displayName": "Developers team",
  "description": "Team grouping all my developers.",
  "members": [
    {
      "value": "123456",
      "$ref": "https://api.gitguardian.com/v1/scim/v2/Users/123456"
    }
  ]
}

Changes

No recorded changes to this operation across all 35 revisions of this API.