For the complete documentation index, see llms.txt. This page is also available as Markdown.

Role-Based Access Control for Cloud9 API keys

Role-Based Access Control (RBAC) is a security paradigm that restricts access to resources based on a user’s role within an organization. When applied to API keys, RBAC ensures that each key has permissions tailored to the responsibilities of the associated role. For example, an API key assigned to a "read-only" role may access data without the ability to modify it, while a "developer" role might have broader privileges like writing or deleting data. By aligning API key permissions with roles, RBAC minimizes security risks, supports the principle of least privilege, and simplifies access management across systems.

Configure Roles for API keys

Cloud9 API users can configure access control for API keys.

When creating a new API key, the Cloud9, firm or custom role admin must set up the key with one of the predefined roles:

  • Admin: Full access to all endpoints and actions

  • Developer: Read and write access to all endpoints but no delete rights

  • Read-Only: Only read access for all endpoints

Requests can only be sent to API endpoints the role allows access to. A 403 error is returned when attempting to send a request to an endpoint that is outside your key’s scope of access.

Possible actions for endpoints are:

  • read - allows access to all endpoints that retrieve information

  • create - allows access to endpoints that add new objects

  • update - allows access to endpoints that modify existing objects

  • delete - allows access to endpoints that remove objects

Last updated