Skip to content

Create a new user group with specified access permissions

Request

Requires groups::modify permissions

Security
JWTAuthorizer
Bodyapplication/jsonrequired

The group object to be created

uidstring

Group unique identifier (UUID)

namestring

Group display name

descriptionstring
referenceIdstring

Internal reference identifier (e.g. "idp-name group-name")

orgIdstring

Organization ID

policyIdsobject

Named policies assigned to this group. May be an object map or an array of policy ID strings depending on context.

typestring

Object type discriminator

Example:"Group"
curl -i -X POST \
  https://apidocs.trustgrid.io/_mock/group \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "uid": "string",
    "name": "string",
    "description": "string",
    "referenceId": "string",
    "orgId": "string",
    "policyIds": {
      "property1": null,
      "property2": null
    },
    "type": "Group"
  }'

Responses

Group successfully created