> For the complete documentation index, see [llms.txt](https://docs.xyb.co/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.xyb.co/xyb-ledger/api-reference-guides/access-permissions-and-settings-management-apis/role-and-permission-management-apis.md).

# Role Management APIs

1. **Create a Role**
   * **Endpoint:** `POST /api/v1/role`
   * **Use Case:** An admin creates a new role with specific permissions to control user access within the platform. This ensures that users are granted appropriate privileges for their responsibilities, such as financial approvals or customer support tasks.
2. **Update a Role**
   * **Endpoint:** `PUT /api/v1/role`
   * **Use Case:** An admin modifies an existing role to add or revoke permissions based on evolving security policies or business needs. For example, a Finance Manager role may be updated to allow system configuration changes.
3. **Retrieve a Role**
   * **Endpoint:** `GET /api/v1/role/{name}`
   * **Use Case:** An admin fetches the details of a specific role to verify its permissions and ensure it aligns with access policies. This helps in auditing and compliance checks for role-based access control.
4. **Delete a Role**
   * **Endpoint:** `DELETE /api/v1/role/{name}`
   * **Use Case:** An admin removes a role that is no longer needed or has been replaced by a different access structure. This prevents redundant or unauthorized access within the system.
5. **List All Roles**
   * **Endpoint:** `GET /api/v1/role/`
   * **Use Case:** An admin retrieves a list of all defined roles in the system to review user access levels. This helps ensure a clear access hierarchy and assists in managing role assignments efficiently.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.xyb.co/xyb-ledger/api-reference-guides/access-permissions-and-settings-management-apis/role-and-permission-management-apis.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.