Zum Inhalt springen
NimbusNexus

Benutzergruppen

Eine Benutzergruppe ist eine benannte Sammlung von Benutzern, denen gemeinsam Rollen erteilt werden können. Statt fünfzehn Entwicklern einzeln die Rolle reader in einem Projekt zu erteilen, erteilen Sie sie der Gruppe backend-team und fügen neue Entwickler der Gruppe hinzu. Erteilen Sie die Rolle mit POST /api/v1/roles/grant und nennen Sie dabei die group und das project; Mitglieder fügen Sie mit POST /api/v1/groups/grant hinzu.

Gruppen gehören zu einem Workspace. Ein Benutzer kann mehreren Gruppen angehören; eine Gruppe kann Rollen in mehreren Projekten ihres Workspaces haben. Rollenzuweisungen sind additiv — ein Benutzer erhält die Vereinigungsmenge aller Rollen, die ihm direkt erteilt wurden, plus aller Rollen, die einer Gruppe erteilt wurden, der er angehört.

Für kleine Teams (unter ~10 Personen) reichen Berechtigungen pro Benutzer meist aus. Gruppen werden irgendwo zwischen 10 und 50 Benutzern zur richtigen Lösung, wenn sich „prüfen, wer Zugriff auf Projekt X hat“ in Sekunden beantworten lassen muss und nicht durch manuelles Durchsehen von 30 IAM-Einträgen.

Nächste Schritte

  • Benutzer — woraus Gruppen bestehen.
  • Rollen — was einer Gruppe erteilt wird.
  • Workspaces — der Bereich, zu dem Gruppen gehören.

Reference

GET/api/v1/groups/

List Groups

List groups in the caller's workspace, optionally filtered by user membership and search term.

Parameters

NameInTypeDescription
userquerystring | null—
searchquerystring | null—

Responses

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

Example

curl -X GET "https://api.nimbusnexus.net/api/v1/groups/" \
  -H "Authorization: Bearer $NIMBUS_KEY"
POST/api/v1/groups/

Create Group

Create a new group in the caller's workspace.

Request body

FieldTypeDescription
name*string—
descriptionstring | null—

Responses

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

Example

curl -X POST "https://api.nimbusnexus.net/api/v1/groups/" \
  -H "Authorization: Bearer $NIMBUS_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Example"
  }'
POST/api/v1/groups/grant

Grant Group

Add users to groups in a single batched call. Every group and user must be in the caller's workspace.

Request body

JSON body required.

Responses

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

Example

curl -X POST "https://api.nimbusnexus.net/api/v1/groups/grant" \
  -H "Authorization: Bearer $NIMBUS_KEY" \
  -H "Content-Type: application/json" \
  -d '[
    {
      "user_id": "<user_id>",
      "group_id": "<group_id>"
    }
  ]'
POST/api/v1/groups/revoke

Revoke Group

Remove users from groups in a single batched call. Every group and user must be in the caller's workspace.

Request body

JSON body required.

Responses

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

Example

curl -X POST "https://api.nimbusnexus.net/api/v1/groups/revoke" \
  -H "Authorization: Bearer $NIMBUS_KEY" \
  -H "Content-Type: application/json" \
  -d '[
    {
      "user_id": "<user_id>",
      "group_id": "<group_id>"
    }
  ]'
GET/api/v1/groups/{group_id}

Get Group

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

Parameters

NameInTypeDescription
group_id*pathstring—

Responses

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

Example

curl -X GET "https://api.nimbusnexus.net/api/v1/groups/<group_id>" \
  -H "Authorization: Bearer $NIMBUS_KEY"
PATCH/api/v1/groups/{group_id}

Update Group

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

Parameters

NameInTypeDescription
group_id*pathstring—

Request body

FieldTypeDescription
namestring | null—
descriptionstring | null—

Responses

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

Example

curl -X PATCH "https://api.nimbusnexus.net/api/v1/groups/<group_id>" \
  -H "Authorization: Bearer $NIMBUS_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
DELETE/api/v1/groups/{group_id}

Delete Group

Delete a group from the caller's workspace.

Parameters

NameInTypeDescription
group_id*pathstring—

Responses

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

Example

curl -X DELETE "https://api.nimbusnexus.net/api/v1/groups/<group_id>" \
  -H "Authorization: Bearer $NIMBUS_KEY"

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