Overview
You can call this API to modify the description of a tenant user.
API details
Constraints
The caller must have an AccessKey for accessing the multi-cloud API. For information about how to obtain the AccessKey ID and AccessKey secret, see Manage AccessKeys.
Request path
PUT api/v2/instances/{instanceId}/tenants/{tenantId}/tenantUsers/{userName}/description
Request parameters
Path
| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | String | Yes | The ID of the instance. |
| tenantId | String | Yes | The ID of the tenant. |
| userName | String | Yes | The name of the user. |
Body
| Parameter | Type | Required | Description |
|---|---|---|---|
| description | String | Yes | The description of the user. |
Response parameters
| Parameter | Type | Description |
|---|---|---|
| requestId | String | The ID of the request. |
| success | Boolean | Indicates whether the request was successful. |
Examples
Request example
curl --digest -u 'ak:sk' \
-X PUT \
'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/tenants/{tenantId}/tenantUsers/{userName}/description' \
--data '{"description":"User description"}'
Response example
JSON format
{
"requestId": "e5b16292-ee78-4433-9233-92b9fcea0dd7",
"success": true
}