Skip to main content
POST
Create user group

Authorizations

Authorization
string
header
required

Bearer token authentication using OAuth2/OIDC tokens

Body

application/json
displayName
string
required

Human-readable display name for the group.

Required string length: 1 - 255
id
string

Client-provided resource identifier. If omitted, the server generates one.

Required string length: 1 - 63
Pattern: ^[a-z]([-a-z0-9]*[a-z0-9])?$
orgId
string

Organization identifier specified when creating group as operator admin. When absent, it will be considered as the current user's organization.

description
string

Human-readable group description

Response

Group successfully created

User group for team-based access control.

uid
string<uuid>
required
read-only

Server-generated UUID.

id
string
required

Name of the resource. Provided by the client when the resource is created, or generated by the server if not specified. Must be 1-63 characters long and match the pattern a-z [blocked]? — the first character must be a lowercase letter, and all following characters must be lowercase letters, digits, or hyphens, with the last character being a letter or digit. Cannot be changed after the resource is created.

Required string length: 1 - 63
Pattern: ^[a-z]([-a-z0-9]*[a-z0-9])?$
Example:

"group-d5e6f7"

displayName
string
required

Human-readable display name for the group.

Required string length: 1 - 255
Example:

"Platform Engineers"

createdAt
string<date-time>
required

Group creation timestamp

Server-defined URL for this resource.

Example:

"/v1/regions/global/iam/groups/group-d5e6f7"

description
string

Human-readable group description

memberCount
integer
read-only

Number of members in the group.

Example:

12

updatedAt
string<date-time>

Group last update timestamp