Description
You can call this operation to grant roles to a user.
Call description
Prerequisites
You have passed the authentication for the OCP application service.
You have the Update permission on the specified tenant.
Request path
POST /api/v2/ob/clusters/{id}/tenants/{tenantId}/users/{username}/grantRole
Request parameters
path parameters
Parameter |
Type |
Required |
Example value |
Description |
|---|---|---|---|---|
| id | Integer | Yes | 1 | The ID of the cluster. |
| tenantId | Integer | Yes | 5 | The ID of the tenant. |
| username | String | Yes | root | The username. |
Request body parameters
Parameter |
Type |
Required |
Example value |
Description |
|---|---|---|---|---|
| roles | StringArray | Yes | [R1, R2] | The list of roles to be granted. |
Response parameters
Parameter |
Type |
Description |
|---|---|---|
| successful | Boolean | Indicates whether the request was successful. |
| timestamp | Datetime | The timestamp when the server completed the request. |
| duration | Integer | The time taken by the server to process the request, in milliseconds. |
| status | Integer | An HTTP status code. |
| traceId | String | The trace ID of the request. This trace ID is used for troubleshooting. |
| server | String | The address of the application server that responded to the request. |
Examples
Sample request
Grant the CONNECT role to USER1 in Tenant 1000001 of Cluster 1.
POST /api/v2/ob/clusters/1/tenants/2000001/users/USER1/grantRole?id=1&tenantId=2000001&username=USER1
{
"roles": [
"CONNECT"
]
}
Sample response
{
"duration": 201,
"server": "a83ad33525",
"status": 200,
"successful": true,
"timestamp": "2021-09-07T15:30:41.205+08:00",
"traceId": "f4783564b21746db"
}