Ir para o conteúdo
NimbusNexus

Users

A user is an identity inside a project. Users hold roles (which grant permissions), can generate API keys (scoped to the user), and can assume trusts to act on behalf of other projects.

User ≠ login

A "user" in this API is the identity record, not the human. The same person can be:

  • One user in prod (the production project)
  • Another user in staging (separate identity record, same email)
  • A third user in dev

Each user is fully isolated from the others — they have their own role assignments, their own API keys, their own audit trail. That's the project-isolation boundary we lean on for blast-radius containment: a compromised dev user can't touch production resources because they literally don't exist as an identity there.

For organizations that want one human → one identity across projects, federate via SAML/OIDC; the SSO-provided identity becomes the same user across all projects mapped by the IdP rules. That's an enterprise feature; default-tier accounts use the per-project model above.

What you can do to a user

  • Create — provision a new user inside the caller's project. Must have iam:write on the project.
  • Get — read a user record. iam:read suffices.
  • Update — change name, description, enabled flag. Some fields (e.g. email) are immutable post-create; the API returns 400 if you try.
  • Delete — permanently remove. All role assignments and API keys owned by the user are revoked atomically.

There's no "disable" separate from "delete." If you want a soft-disable (keep audit history, prevent login), set enabled: false via update — that's the soft-disable path. Delete is hard-delete + revoke everything.

What you can't do

  • Move a user between projects. Create a new user in the target project, copy the role grants you want, delete the old one.
  • Set a password via API. Passwords go through the password-reset flow only; the API never accepts a plaintext password as input. Users with SSO bypass passwords entirely.
  • List users in a project you don't have role assignments on. The project isolation is hard — no cross-project enumeration.

What's next

  • Projects — the container users live in.
  • Roles — what to grant a user once they exist.
  • Authentication — how API keys (issued per user) work.

Reference

POST/api/v1/api_keys/

Create Api Key

Create an application credential (API key). The secret is returned only once.

Request body

JSON body required.

Responses

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

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

GET/api/v1/api_keys/access_rules/list

List Access Rules

List the access rules associated with a user's application credentials.

Responses

  • 200Successful Response
  • 400Bad Request
  • 401Unauthorized
  • 403Forbidden
  • 404Not Found
  • 422Validation error
  • 500Internal Server Error

https://api.nimbusnexus.net/api/v1/api_keys/access_rules/list

GET/api/v1/api_keys/access_rules/{access_rule_id}

Get Access Rule

Show the details of a single access rule by id.

Parameters

NameInRequiredDescription
access_rule_idpathyes—

Responses

  • 200Successful Response
  • 400Bad Request
  • 401Unauthorized
  • 403Forbidden
  • 404Not Found
  • 422Validation Error
  • 500Internal Server Error

https://api.nimbusnexus.net/api/v1/api_keys/access_rules/{access_rule_id}

GET/api/v1/api_keys/list

List Api Keys

List application credentials (API keys) belonging to the current user. Secrets are never returned.

Responses

  • 200Successful Response
  • 400Bad Request
  • 401Unauthorized
  • 403Forbidden
  • 500Internal Server Error

https://api.nimbusnexus.net/api/v1/api_keys/list

GET/api/v1/api_keys/{api_key_id}

Get Api Key

Get a single application credential (API key) by id.

Parameters

NameInRequiredDescription
api_key_idpathyes—

Responses

  • 200Successful Response
  • 400Bad Request
  • 401Unauthorized
  • 403Forbidden
  • 404Not Found
  • 422Validation Error
  • 500Internal Server Error

https://api.nimbusnexus.net/api/v1/api_keys/{api_key_id}

DELETE/api/v1/api_keys/{api_key_id}

Delete Api Key

Delete (revoke) an application credential (API key).

Parameters

NameInRequiredDescription
api_key_idpathyes—

Responses

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

https://api.nimbusnexus.net/api/v1/api_keys/{api_key_id}

GET/api/v1/users/

List Users

List identity users in the current scope, optionally filtered by group membership and search term.

Parameters

NameInRequiredDescription
groupqueryno—
searchqueryno—

Responses

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

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

POST/api/v1/users/

Create User

Create a new user in the caller's workspace with the given name, password and enabled flag.

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/users/

GET/api/v1/users/{user_id}

Get User

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

Parameters

NameInRequiredDescription
user_idpathyes—

Responses

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

https://api.nimbusnexus.net/api/v1/users/{user_id}

PATCH/api/v1/users/{user_id}

Update User

Update mutable attributes of a user (name, description, enabled, password) and return the updated record.

Parameters

NameInRequiredDescription
user_idpathyes—

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/users/{user_id}

DELETE/api/v1/users/{user_id}

Delete User

Permanently delete a user by ID.

Parameters

NameInRequiredDescription
user_idpathyes—

Responses

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

https://api.nimbusnexus.net/api/v1/users/{user_id}

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