Zum Inhalt springen
NimbusNexus

Workspaces

Ein Workspace ist die oberste Isolationsebene im Kontomodell von NimbusNexus. Jedes Projekt gehört zu genau einem Workspace; der Zugriff jedes Benutzers ist auf Workspaces beschränkt (und auf bestimmte Projekte darin). Die Hierarchie lautet Workspace → Projekt → Ressource.

Für die meisten Konten reicht ein einziger Workspace. Größere Organisationen nutzen mehrere Workspaces, um Abrechnung, Zugriff und Ressourcenlimits auf Ebene von Organisationseinheiten zu trennen — z. B. ein Workspace pro Geschäftsbereich oder einer pro juristischer Person. Abgerechnet wird pro Workspace, und Zugriff überschreitet die Grenze eines Workspaces nur, wenn Sie sie öffnen: Sie laden jemanden ein, oder Sie teilen ein Netzwerk oder eine DNS-Zone mit einem anderen Projekt.

Verwechseln Sie einen Workspace nicht mit einer DNS-Zone — in manchen Kontexten wird dasselbe Wort verwendet (OpenStack nennt Workspaces „Domains“). Die API behält das Wort von OpenStack bei: Die Endpoints für Workspaces liegen unter /api/v1/domains/, und auch ihre Felder sprechen von Domain (domain_id, domain_name, domain_description).

Nächste Schritte

  • Projekte — die nächste Ebene darunter; was Workspaces enthalten.
  • Benutzer und Rollen — IAM-Berechtigungen gelten innerhalb eines Workspaces.
  • Projektübergreifende Trusts — kurzlebige Delegierungen, mit denen NimbusNexus in einem Projekt Arbeit für Sie abschließt.

Reference

GET/api/v1/domains/

Find Domain

List domains visible to the caller, optionally filtered by a name search term.

Parameters

NameInTypeDescription
admin_domainquerystring | null—
admin_projectquerystring | null—
searchquerystring | null—

Responses

  • 200Successful Response
  • 401Unauthorized
  • 403Forbidden
  • 422Validation error
  • 500Internal Server Error

Example

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

Create Domain

Create a new domain. Needs a system admin.

Request body

FieldTypeDescription
name*stringDomain name
descriptionstring | null—
enabledboolean | null—

Responses

  • 201Successful Response
  • 400Bad Request
  • 401Unauthorized
  • 403Forbidden
  • 422Validation error
  • 500Internal Server Error

Example

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

Update Domain

Update the name, description or enabled state of an existing domain. Needs a system admin. The platform's own domains can't be renamed or disabled.

Request body

FieldTypeDescription
domain_id*stringDomain ID
domain_namestring | null—
domain_descriptionstring | null—
enabledboolean | 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/domains/" \
  -H "Authorization: Bearer $NIMBUS_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "domain_id": "<domain_id>"
  }'
DELETE/api/v1/domains/

Delete Domain

Disable (if needed) and delete a domain along with its descendants. Needs a system admin. The platform's own domains can't be deleted. If the delete fails, a domain this call disabled is enabled again.

Request body

FieldTypeDescription
id*stringDomain ID

Responses

  • 204Successful Response
  • 401Unauthorized
  • 403Forbidden
  • 404Not Found
  • 422Validation Error
  • 500Internal Server Error

Example

curl -X DELETE "https://api.nimbusnexus.net/api/v1/domains/" \
  -H "Authorization: Bearer $NIMBUS_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "example"
  }'
POST/api/v1/domains/invite

Invite To Domain

Invite a user by email to a domain with the specified role and notify them in-app and via email.

Request body

FieldTypeDescription
domain*stringProject ID
role_id*string—
email*string—

Responses

  • 201Successful Response
  • 422Validation Error

Example

curl -X POST "https://api.nimbusnexus.net/api/v1/domains/invite" \
  -H "Authorization: Bearer $NIMBUS_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "domain": "example",
    "role_id": "<role_id>",
    "email": "[email protected]"
  }'
POST/api/v1/domains/invite_action

Invite Action

Accept or decline a pending domain invitation, applying or revoking the offered role accordingly.

Request body

FieldTypeDescription
access*boolean—
notification_id*string—

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/domains/invite_action" \
  -H "Authorization: Bearer $NIMBUS_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "access": true,
    "notification_id": "<notification_id>"
  }'
GET/api/v1/domains/{domain_id}

Show Domain

Retrieve a single domain by ID. Needs a role on the domain or on one of its projects, or a session in admin mode.

Parameters

NameInTypeDescription
domain_id*pathstring—

Responses

  • 200Successful Response
  • 401Unauthorized
  • 403Forbidden
  • 422Validation error
  • 500Internal Server Error

Example

curl -X GET "https://api.nimbusnexus.net/api/v1/domains/<domain_id>" \
  -H "Authorization: Bearer $NIMBUS_KEY"

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