All Products
Search
Document Center

ApsaraDB for OceanBase:ModifyTenantUserRoles

Last Updated:Dec 02, 2024

You can call this operation to modify the database privileges of a specified account in a tenant.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
oceanbase:ModifyTenantUserRolesupdate
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
UserNamestringYes

The role of the database account.

pay_test
TenantIdstringYes

The operation that you want to perform.
Set the value to ModifyTenantUserRoles.

ob2mr3oae0****
UserRolestringYes

The type of the account. Valid values:

  • Admin: the super administrator account.
  • Normal: a general account.
[{"Database":"20210824160559","Role":"readwrite"}]
InstanceIdstringYes

The type of the privilege modification operation.
Valid values:
update: updates all privileges. This is the default value.
add: adds a privilege.
delete: deletes a privilege.

ob317v4uif****
ModifyTypestringNo

The name of the table.

update

Response parameters

ParameterTypeDescriptionExample
object

The list of database privileges of the account.

TenantUserobject

The ID of the tenant.

UserRolearray<object>

The name of the database (MySQL mode) or schema (Oracle mode).

UserRoleobject

The request ID.

Databasestring
http(s)://[Endpoint]/?Action=ModifyTenantUserRoles
&UserName=pay_test
&TenantId=ob2mr3oae0****
&UserRole=[{"Database":"20210824160559","Role":"readwrite"}]
&InstanceId=ob317v4uif****
&ModifyType=update
&Common request parameters
db_pay1
Rolestring

You can call this operation to modify the database privileges of a specified account in a tenant.

ReadOnly

Examples

Sample success responses

JSONformat

{
  "TenantUser": {
    "UserRole": [
      {
        "Database": "db_pay1",
        "Role": "ReadOnly",
        "Table": "tbl_pay1",
        "IsSuccess": true
      }
    ],
    "UserName": "pay_test",
    "TenantId": "t33h8y08k****"
  },
  "RequestId": "EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C"
}

Error codes

HTTP status codeError codeError message
500InternalErrorThe request processing has failed due to some unknown error.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-07-04The Error code has changedView Change Details