Skip to main content
POST
Create a group
Dashboard session only. API keys cannot call this operation.

Authorizations

Authorization
string
header
required

ID token of a signed-in dashboard user. Operations that API keys cannot call use it.

Headers

Idempotency-Key
string

Optional on every POST: 1-255 printable ASCII characters without spaces (a UUID is recommended). The same key with the same request replays the stored response for 24 hours. See Idempotency.

Required string length: 1 - 255
Pattern: ^[\x21-\x7E]{1,255}$

Body

application/json

Create a group.

name
string
required

1-80 characters, unique.

Maximum string length: 80
description
string | null

Up to 500 characters.

Maximum string length: 500
permissions
string[]

Up to 100.

Maximum array length: 100

Permission.

memberIds
integer<uint64>[]

Up to 500 membership ids.

Maximum array length: 500

Unsigned 64-bit integer. May exceed 2^53; parse with a BigInt-safe JSON parser in JavaScript.

Required range: 0 <= x <= 18446744073709552000

Response

Success.

Single-object envelope around Group.

data
object
required

A group of members with permissions.