All URIs are relative to http://localhost
| Method | HTTP request | Description |
|---|---|---|
| AddMembersToRole | Post /roles/{id}/members | Add members to a role |
| CreateRole | Post /roles | Create a role |
| DeleteRole | Delete /roles/{id} | Get a role by its ID |
| GetRole | Get /roles/{id} | Get a role by its ID |
| ListRoles | Get /roles | List all roles |
| RemoveMembersFromRole | Delete /roles/{id}/members | Remove members from a role |
AddMembersToRole($id, $body)
Add members to a role
A Role represents a group of users that share the same role and thus permissions. A role could be an administrator, a moderator, a regular user or some other sort of role. This endpoint allows you to add members (users, applications, ...) to a specific role. You have to know the role's ID.
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | The id of the role to modify. | |
| body | RoleMembers | [optional] |
void (empty response body)
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Role CreateRole($body)
Create a role
A Role represents a group of users that share the same role and thus permissions. A role could be an administrator, a moderator, a regular user or some other sort of role. This endpoint allows you to create a new role. You may define members as well but you don't have to.
| Name | Type | Description | Notes |
|---|---|---|---|
| body | Role | [optional] |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DeleteRole($id)
Get a role by its ID
A Role represents a group of users that share the same role and thus permissions. A role could be an administrator, a moderator, a regular user or some other sort of role. This endpoint allows you to delete an existing role. You have to know the role's ID.
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | The id of the role to look up. |
void (empty response body)
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Role GetRole($id)
Get a role by its ID
A Role represents a group of users that share the same role and thus permissions. A role could be an administrator, a moderator, a regular user or some other sort of role. This endpoint allows you to retrieve an existing role. You have to know the role's ID.
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | The id of the role to look up. |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
[]Role ListRoles($member, $limit, $offset)
List all roles
A Role represents a group of users that share the same role and thus permissions. A role could be an administrator, a moderator, a regular user or some other sort of role. This endpoint allows you to retrieve all roles that are stored in the system.
| Name | Type | Description | Notes |
|---|---|---|---|
| member | string | The id of the member to look up. | [optional] |
| limit | int64 | The maximum amount of policies returned. | [optional] |
| offset | int64 | The offset from where to start looking. | [optional] |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RemoveMembersFromRole($id, $body)
Remove members from a role
A Role represents a group of users that share the same role and thus permissions. A role could be an administrator, a moderator, a regular user or some other sort of role. This endpoint allows you to remove members (users, applications, ...) from a specific role. You have to know the role's ID.
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | The id of the role to modify. | |
| body | RoleMembers | [optional] |
void (empty response body)
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]