User groups

A user group is a named collection of users that can be granted roles together. Instead of granting vms:read to fifteen engineers individually, you grant it to the backend-team group and add new engineers to the group.

Groups are scoped to a workspace. A user can belong to multiple groups; a group can hold roles in multiple projects within its workspace. Role assignments are additive — a user gets the union of every role granted directly to them plus every role granted to a group they belong to.

For small teams (under ~10 people) per-user grants are usually fine. Groups become the right answer somewhere between 10 and 50 users, when "audit who has access to project X" needs to be answerable in seconds and not by hand-checking 30 IAM entries.

What's next

Users — the things groups contain.
Roles — what gets granted to a group.
Workspaces — groups are scoped here.

Reference

GET/api/v1/groups/

List Groups

List groups in the current scope, optionally filtered by user membership and search term.

Parameters

Name	In	Required	Description
user	query	no	—
search	query	no	—

Responses

200Successful Response
400Bad Request
401Unauthorized
403Forbidden
404Not Found
409Conflict
422Validation error
429Too Many Requests
500Internal Server Error

https://api.nimbusnexus.net/api/v1/groups/

POST/api/v1/groups/

Create Group

Create a new group in the caller's workspace.

Request body

JSON body required.

Responses

201Successful Response
400Bad Request
401Unauthorized
403Forbidden
404Not Found
409Conflict
422Validation error
429Too Many Requests
500Internal Server Error

https://api.nimbusnexus.net/api/v1/groups/

POST/api/v1/groups/grant

Grant Group

Add one or more users to one or more groups in a single batched call.

Request body

JSON body required.

Responses

200Successful Response
400Bad Request
401Unauthorized
403Forbidden
404Not Found
409Conflict
422Validation error
429Too Many Requests
500Internal Server Error

https://api.nimbusnexus.net/api/v1/groups/grant

POST/api/v1/groups/revoke

Revoke Group

Remove one or more users from one or more groups in a single batched call.

Request body

JSON body required.

Responses

200Successful Response
400Bad Request
401Unauthorized
403Forbidden
404Not Found
409Conflict
422Validation error
429Too Many Requests
500Internal Server Error

https://api.nimbusnexus.net/api/v1/groups/revoke

GET/api/v1/groups/{group_id}

Get Group

Retrieve a single group by ID, scoped to the caller's workspace.

Parameters

Name	In	Required	Description
group_id	path	yes	—

Responses

200Successful Response
400Bad Request
401Unauthorized
403Forbidden
404Not Found
409Conflict
422Validation error
429Too Many Requests
500Internal Server Error

https://api.nimbusnexus.net/api/v1/groups/{group_id}

PATCH/api/v1/groups/{group_id}

Update Group

Update the name or description of an existing group within the caller's workspace.

Parameters

Name	In	Required	Description
group_id	path	yes	—

Request body

JSON body required.

Responses

200Successful Response
400Bad Request
401Unauthorized
403Forbidden
404Not Found
409Conflict
422Validation error
429Too Many Requests
500Internal Server Error

https://api.nimbusnexus.net/api/v1/groups/{group_id}

DELETE/api/v1/groups/{group_id}

Delete Group

Delete a group from the caller's workspace.

Parameters

Name	In	Required	Description
group_id	path	yes	—

Responses

204Successful Response
400Bad Request
401Unauthorized
403Forbidden
404Not Found
409Conflict
422Validation error
429Too Many Requests
500Internal Server Error

https://api.nimbusnexus.net/api/v1/groups/{group_id}

Need to make a real call? Try these endpoints in the live Swagger UI →

Edit this page on GitHub