v50

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

enterprise-admin

Provision a SCIM enterprise group

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

Creates a SCIM group for an enterprise.

If members are included as part of the group provisioning payload, they will be created as external group members. It is up to a provider to store a mapping between the externalId and id of each user.

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

Path parameters

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 has been created