# The Co-operative Bank Roles API

**Canonical:** https://apis.io/apis/co-operative-bank/co-operative-bank-roles-api/  
**Provider:** The Co-operative Bank — https://apis.io/providers/co-operative-bank/  
**Base URL:** https://openbanking-retail.apis.co-operativebank.co.uk/apis/retail/open-banking/v3.1/aisp  
**Documentation:** https://www.developer.co-operativebank.co.uk/apis/aisp/

The Co-operative Bank Roles API is one of 76 APIs that [The Co-operative Bank](https://apis.io/providers/co-operative-bank/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Roles. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

User role and permission management

## Operations (19)

| Method | Path | Summary |
|---|---|---|
| GET | `/api/role/loadbyid/{params}` | Load role by ID (deprecated) |
| GET | `/api/role/loadbyname/{params}` | Load roles by name filter (deprecated) |
| GET | `/api/role/loadchildren/{params}` | Load role children (deprecated) |
| GET | `/api/v1/roles` | Load root roles |
| POST | `/api/v1/roles` | Create new role |
| POST | `/api/v1/roles/{roleid}/users/{userId}` | Grant a role to a user |
| GET | `/api/v1/roles/checkuserroles/userid/{userId}/roleids/{roleIds}` | Check user roles |
| GET | `/api/v1/roles/{roleid}` | Load role by role ID |
| PUT | `/api/v1/roles/{roleid}` | Update a role |
| DELETE | `/api/v1/roles/{roleid}` | Delete a role |
| GET | `/api/v1/roles/layouts` | Get all layouts |
| POST | `/api/v1/roles/layouts` | Save role layouts |
| DELETE | `/api/v1/roles/layouts` | Delete role layouts |
| GET | `/api/v1/roles/{roleId}/layouts` | Find role layouts |
| GET | `/api/v1/roles/users/{userIdOrEmail}` | Load user roles |
| GET | `/api/v1/roles/{roleid}/rolehierarchyanduserroles` | Load users and roles by role ID |
| GET | `/api/v1/roles/{roleid}/users` | Get the users directly granted a role |
| DELETE | `/api/v1/roles/{roleid}/users` | Remove users from a role |
| GET | `/api/v1/roles/_search` | Search Roles |

## Machine-readable artifacts (3)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/co-operative-bank/refs/heads/main/openapi/co-operative-bank-roles-api-openapi.yml
- **Documentation** — https://openbankinguk.github.io/opendata-api-docs-pub/v2.4.0/
- **APIReference** — https://openbankinguk.github.io/opendata-api-docs-pub/v2.4.0/atmlocator/atm-locator.html

## Other The Co-operative Bank APIs (12)

- [The Co-operative Bank Account Information API (AIS)](https://apis.io/apis/co-operative-bank/account-information-api/)
- [The Co-operative Bank Payment Initiation API (PIS)](https://apis.io/apis/co-operative-bank/payment-initiation-api/)
- [The Co-operative Bank Confirmation of Funds API (CBPII)](https://apis.io/apis/co-operative-bank/confirmation-of-funds-api/)
- [The Co-operative Bank Accessibility Agent API](https://apis.io/apis/co-operative-bank/co-operative-bank-accessibility-agent-api/)
- [The Co-operative Bank Accessibility Checker API](https://apis.io/apis/co-operative-bank/co-operative-bank-accessibility-checker-api/)
- [The Co-operative Bank Administration API](https://apis.io/apis/co-operative-bank/co-operative-bank-administration-api/)
- [The Co-operative Bank AI API](https://apis.io/apis/co-operative-bank/co-operative-bank-ai-api/)
- [The Co-operative Bank Announcements API](https://apis.io/apis/co-operative-bank/co-operative-bank-announcements-api/)
- [The Co-operative Bank API Token API](https://apis.io/apis/co-operative-bank/co-operative-bank-api-token-api/)
- [The Co-operative Bank Apps API](https://apis.io/apis/co-operative-bank/co-operative-bank-apps-api/)
- [The Co-operative Bank Authentication API](https://apis.io/apis/co-operative-bank/co-operative-bank-authentication-api/)
- [The Co-operative Bank Browser Tree API](https://apis.io/apis/co-operative-bank/co-operative-bank-browser-tree-api/)

## Tags

Roles

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/co-operative-bank/co-operative-bank-roles-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/co-operative-bank/.