BEbeyondidentity
SCIM

Create a New Group

Creates a new SCIM Group resource. Send a POST request to /Groups with a JSON body containing the group attributes. The server will generate any required unique identifiers for the new Group. As per RFC-7644 §3.3, the response includes a Location header pointing to the newly created resource. Read-only attributes (e.g., 'id', 'meta') specified in the request body will be ignored. The service provider will evaluate the request body against the Group schema defined in RFC-7643 §4.2 to ensure validity. If the request body fails validation, a 400 error will be returned with details about the validation failure.

post/scim/v2/Groups

Request

Request body

schemasstring[] required

The list of schemas used to define the group. This must contain the core Group schema ("urn:ietf:params:scim:schemas:core:2.0:Group") and may include the custom Beyond Identity Group schema extension ("urn:scim:schemas:extension:byndid:1.0:Group").

idstring

The unique ID of the group. This is automatically generated on creation. This field is immutable and output-only.

displayNamestring required

The unique display name of the group. This name is used for display purposes.

Example request

{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:Group"
  ],
  "id": "ed9fcce6-ec82-458e-ae58-e2d975cfc32d",
  "displayName": "Help Desk",
  "members": [
    {
      "display": "Test Display",
      "value": "903a4c7e-2ce8-4eea-a186-cff804a4279d",
      "$ref": "https://api.byndid.com/scim/v2/Users/903a4c7e-2ce8-4eea-a186-cff804a4279d",
      "type": "User"
    }
  ],
  "urn:scim:schemas:extension:byndid:1.0:Group": {
    "description": "This group contains members of the Help Desk."
  }
}

Response

The response will be a JSON object containing the standard attributes associated with a group.

schemasstring[] required

The list of schemas used to define the group. This must contain the core Group schema ("urn:ietf:params:scim:schemas:core:2.0:Group") and may include the custom Beyond Identity Group schema extension ("urn:scim:schemas:extension:byndid:1.0:Group").

idstring required

The unique ID of the group. This is automatically generated on creation. This field is immutable and output-only.

displayNamestring required

The unique display name of the group. This name is used for display purposes.

metaMeta required(unresolved $ref)

Changes

No recorded changes to this operation across all 1 revision of this API.