--- title: "Create a New Group" method: POST path: "/scim/v2/Groups" tags: ["SCIM"] --- # Create a New Group `POST /scim/v2/Groups` ## Request - Base URL: `https://api.byndid.com` - URL: `https://api.byndid.com/scim/v2/Groups` - Auth: HTTP bearer - TypeScript: (a function with typed inputs; its response is checked against the schema) 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](https://datatracker.ietf.org/doc/html/rfc7644#section-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](https://datatracker.ietf.org/doc/html/rfc7643#section-4.2) to ensure validity. If the request body fails validation, a 400 error will be returned with details about the validation failure. ## Request body - object: A group is a collection of users corresponding to [RFC 7643 Section 4.2](https://www.rfc-editor.org/rfc/rfc7643#section-4.2). - `schemas` string[], 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"). - `id` string: The unique ID of the group. This is automatically generated on creation. This field is immutable and output-only. - `displayName` string, required: The unique display name of the group. This name is used for display purposes. - `members` object[]: The list of the group's members. Please note that only users can be added as members. If a non-existing user is specified, the endpoint will return a 404 error. - `display` string: The display name of the group member, primarily used for display purposes. - `value` string: ID of the user resource corresponding to the group member. This field is immutable. - `$ref` string: The URI to another user resource that is a member of the group. This is field is only used for requests and is not returned on the response. - `type` string: The resource type of the group member. Currently, only users are supported as group members. This field is only used for requests and is not returned on the response. Specifying a group as a group member on a request is unsupported and will result in undefined behavior. - `urn:scim:schemas:extension:byndid:1.0:Group` object: The Beyond Identity Group schema extension. - `description` string: Description of the group. ## Response `201` The response will be a JSON object containing the standard attributes associated with a group. - SCIMGroup: A group is a collection of users corresponding to [RFC 7643 Section 4.2](https://www.rfc-editor.org/rfc/rfc7643#section-4.2). - `schemas` string[], 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"). - `id` string, required: The unique ID of the group. This is automatically generated on creation. This field is immutable and output-only. - `displayName` string, required: The unique display name of the group. This name is used for display purposes. - `members` object[]: The list of the group's members. - `display` string: The display name of the group member, primarily used for display purposes. - `value` string: ID of the user resource corresponding to the group member. This field is immutable. - `$ref` string: The URI to another user resource that is a member of the group. This is field is only used for requests and is not returned on the response. - `type` string: The resource type of the group member. Currently, only users are supported as group members. This field is only used for requests and is not returned on the response. Specifying a group as a group member on a request is unsupported and will result in undefined behavior. - `urn:scim:schemas:extension:byndid:1.0:Group` object, required: The Beyond Identity Group schema extension. - `description` string, required: Description of the group. - `meta` Meta, required (unresolved $ref) ## Other responses - `400`: Bad request. - `401`: Unauthorized. - `409`: Conflict error. The request could not be completed due to a conflict with the current state of the target resource. This occurs when attempting to create a group with a displayName that is already in use by another group. - `429`: Rate limit exceeded. - `500`: Server error. --- [API](https://skmtc.dev/beyondidentity/apis/beyond-identity-secure-workforce-api.md) - [All operations](https://skmtc.dev/beyondidentity/apis/beyond-identity-secure-workforce-api/llms.txt) - [OpenAPI document](https://skmtc.dev/beyondidentity/apis/beyond-identity-secure-workforce-api/revisions/562e14b2e4ba?raw)