This API allows you to manage user roles and permissions within your application. It provides endpoints to create, update, delete, and retrieve user roles and permissions.
Features
- Create Role: Create a new role with specified permissions.
- Update Role: Update the permissions of an existing role.
- Delete Role: Remove a role from the system.
- List Roles: Retrieve a list of all roles.
- Assign Role to User: Assign a role to a user.
- Remove Role from User: Remove a role from a user.
Usage
To use this API, you need to send a HTTP request to the appropriate endpoint with the required parameters.
Create Role
To create a new role, send a POST request to /Documentation/en/Developer/APIs/UserManagement/CreateRole
.
{
"name": "Admin",
"permissions": ["read", "write", "delete"]
}
Update Role
To update the permissions of an existing role, send a PUT request to /Documentation/en/Developer/APIs/UserManagement/UpdateRole
.
{
"name": "Admin",
"permissions": ["read", "write"]
}
Delete Role
To delete a role, send a DELETE request to /Documentation/en/Developer/APIs/UserManagement/DeleteRole
.
{
"name": "Admin"
}
List Roles
To retrieve a list of all roles, send a GET request to /Documentation/en/Developer/APIs/UserManagement/ListRoles
.
{
"roles": [
{
"name": "Admin",
"permissions": ["read", "write", "delete"]
},
{
"name": "User",
"permissions": ["read"]
}
]
}
Assign Role to User
To assign a role to a user, send a POST request to /Documentation/en/Developer/APIs/UserManagement/AssignRoleToUser
.
{
"userId": 1,
"roleName": "Admin"
}
Remove Role from User
To remove a role from a user, send a DELETE request to /Documentation/en/Developer/APIs/UserManagement/RemoveRoleFromUser
.
{
"userId": 1,
"roleName": "Admin"
}
For more information, please visit our Developer Documentation.