Groups
K0rdent Api Groups endpoints
Groups Endpoints
| Method | Endpoint | Description |
|---|---|---|
GET | /v1/regions/global/iam/groups | Visibility: public · internal ( OpenAPI Custom Extension: x-visibility ) List all user groups for team-based access control. |
GET | /v1/regions/global/iam/groups/{groupId}/members | Visibility: public · internal ( OpenAPI Custom Extension: x-visibility ) List members of a group with pagination. Returns membership records that include denormalized user details (display name, email) for convenience. |
GET | /v1/regions/global/iam/groups/{groupId}/members/{id} | Visibility: public · internal ( OpenAPI Custom Extension: x-visibility ) Retrieve a single membership record for a user within a group. Returns 404 if the user is not a member of the group. |
GET | /v1/regions/global/iam/groups/{id} | Visibility: public · internal ( OpenAPI Custom Extension: x-visibility ) Retrieve group details. |
POST | /v1/regions/global/iam/groups | Visibility: public · internal ( OpenAPI Custom Extension: x-visibility ) Create a new user group. |
POST | /v1/regions/global/iam/groups/{groupId}/members | Visibility: public · internal ( OpenAPI Custom Extension: x-visibility ) Add a user to the group. If the user is already a member, returns 409 Conflict. |
PATCH | /v1/regions/global/iam/groups/{id} | Visibility: public · internal ( OpenAPI Custom Extension: x-visibility ) Update group details. Use the /groups/{id}/members sub-resource for membership changes. |
DELETE | /v1/regions/global/iam/groups/{groupId}/members/{id} | Visibility: public · internal ( OpenAPI Custom Extension: x-visibility ) Remove a user from the group. Returns 404 if the user is not a member. |
DELETE | /v1/regions/global/iam/groups/{id} | Visibility: public · internal ( OpenAPI Custom Extension: x-visibility ) Delete a user group. |
How is this guide?