Sign in
Group

Create Group

Creates a group. Group roles will take effect based on the location, where the group is being created. Read more at How to use location and folders.

post/groups

Query parameters

fieldsstring

A comma separated list of fields to include in the response. Every value in the list should either consist of a top-level property name (excluding the items envelope for endpoints returning lists) or refer to a property of a top-level property of type object, in the following form: "toplevelpropertyname.subpropertyname". When this query parameter is omitted, default resource representations are returned (excluding fields marked as optional). The same applies to nested objects when just specifying the top-level property name, without explicitly listing sub-property names. When specifying the fields query parameter, only the specified fields are returned. The id property is always returned.

Headers

Authorizationstring required

The bearer access token provided by Auth0.

X-LC-Tenantstring required

The identifier of the account where the request is executed.

Request body

namestring required

The group name.

descriptionstring

The group description.

rolesstring[] required

The identifiers of the roles associated with the group.

usersstring[]

The identifiers of the users who will be part of the group.

locationstring required

The folder identifier where the group will be created.

Response

Created.

idstring required

The group identifier.

namestring
<div style="display:inline; float:right; color:#008080; margin-top:-23px; font-size:11px">default</div><div style="display: inline;">The group name.</div>
descriptionstring

The group description.

groupType'default' | 'custom' | 'vendor' | 'customer'
  • default : groups in the Root folder (location) provisioned by the system, automatically. Examples: Administrator, Project Manager, Engineer, Terminologist.
  • customer : groups provisioned by the system, automatically, for each customer location you add. Examples: Customer Requester, Customer Reviewer.
  • vendor : group provisioned by the system, automatically, for each vendor location you add. Examples: Vendor Project Manager.
  • custom : groups you can create in a location of your choice. Examples: Project Manager, Translator.

Example response

{
  "roles": [
    {
      "permissions": [
        {
          "name": "projectCreate",
          "category": "Projects",
          "entityType": {
            "name": "Projects"
          },
          "dependsOn": [
            "projectRead"
          ]
        }
      ]
    }
  ],
  "additionalRoles": [
    {
      "roles": [
        {
          "permissions": [
            {
              "name": "projectCreate",
              "category": "Projects",
              "entityType": {
                "name": "Projects"
              },
              "dependsOn": [
                "projectRead"
              ]
            }
          ]
        }
      ]
    }
  ]
}

Changes