Create an organization user group

Creates a new organization user group.

POST/v3/organizations/{organizationId}/user-groups
JWT
organization:userGroup:create

Parameters

NameTypeInDescription
organizationId*stringpath

Request Body Schema

PropertyTypeDescriptionConstraints
name*stringName of the user group.min: 1, max: 256
descriptionstringDescription for the user group.min: 0, max: 256

Request Example

{
  "name": "string",
  "description": "string"
}
Triggers webhook: organization.userGroup.created
POST <your-webhook-url>
{
  "event": "organization.userGroup.created",
  "data": {
    "id": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "name": "string",
    "description": "string"
  },
  "triggeredAt": "string"
}

Responses

201 Created
{
  "id": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "name": "string",
  "description": "string"
}