v50

latestOpenAPI 3.0.3MITraw.githubusercontent.com2024-03-2585861610.1 MB

enterprise-admin

Set SCIM information for a provisioned enterprise group

Note: The SCIM API endpoints for enterprise accounts are currently in private 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.

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

Path parameters

scim_group_idstring required

Example:7fce0092-d52e-4f76-b727-3955bd72c939

A unique identifier of the SCIM group.

enterprisestring required

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

Request body

schemasstring[] required

The URIs that are used to indicate the namespaces of the SCIM schemas.

externalIdstring required

A unique identifier for the resource as defined by the provisioning client.

displayNamestring required

A human-readable name for a security group.

Example request

{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:Group"
  ],
  "externalId": "8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159",
  "displayName": "Engineering",
  "members": [
    {
      "value": "23a35c27-23d3-4c03-b4c5-6443c09e7173",
      "displayName": "Monalisa Octocat"
    }
  ]
}

Response

Group was updated