Create user group - Omni Docs

curl --request POST \ --url https://{instance}.omniapp.co/api/scim/v2/groups \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "displayName": "Blob Sales", "members": [ { "value": "9e8719d9-276a-4964-9395-a493189a247c" } ] } '

{ "displayName": "Blob Sales", "id": "mEhXj6ZI", "meta": { "created": "2024-12-04T00:08:03.250Z", "lastModified": "2024-12-04T00:08:03.250Z", "resourceType": "Group" }, "schemas": [ "urn:ietf:params:scim:schemas:core:2.0:Group" ], "members": [ { "display": "blob.ross@blobsrus.co", "value": "9e8719d9-276a-4964-9395-a493189a247c" } ] }

Authorizations

Authorization

string

header

required

Requires an Organization API Key. Personal Access Tokens (PATs) are not supported for this endpoint.

Include in the Authorization header as: Bearer ORGANIZATION_API_KEY

Body

application/json

displayName

string

required

The name of the group. Names must be 64 characters or less.

Example:

"Blob Sales"

members

object[]

A list of users to add as group members. Each member should be specified as an object containing a user ID.

Show child attributes

Example:

[
  {
    "value": "9e8719d9-276a-4964-9395-a493189a247c"
  }
]

Response

Group created successfully

string

Unique identifier for the group

displayName

string

The name of the group

members

object[]

The list of users in the group

Show child attributes