All Products
Search
Document Center

Data Management:GrantTemplateAuthority

Last Updated:Nov 28, 2024

Grants permissions on resources to users by using a permission template.

Operation description

You must be a database administrator (DBA) or a Data Management (DMS) administrator. For more information about how to view system roles, see View system roles.

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
dms:GrantTemplateAuthoritynone
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
TemplateIdlongYes

The ID of the permission template.

1563
UserIdsstringYes

The IDs of users to which you want to grant permissions on resources by using the permission template.

[12***,34***,56***]
ExpireDatestringYes

The time when the permission expires. Specify the time in the yyyy-MM-DD HH:mm:ss format.

2023-03-08 17:58:53
CommentstringNo

The reason why you want to grant permissions on resources to the users by using the permission template.

Business test.
TidlongNo

The ID of the tenant. You can call the GetUserActiveTenant or ListUserTenants operation to query the tenant ID.

3***

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The ID of the request.

34E01EDD-6A16-4CF0-9541-C644D1BE01AA
Successboolean

Indicates whether the request was successful. Valid values:

  • true: The request was successful.
  • false: The request failed.
true
ErrorMessagestring

The error message returned if the request failed.

UnknownError
ErrorCodestring

The error code.

UnknownError
Resultboolean

Indicates whether the permissions on resources were granted to the users by using the permission template.

true

Examples

Sample success responses

JSONformat

{
  "RequestId": "34E01EDD-6A16-4CF0-9541-C644D1BE01AA",
  "Success": true,
  "ErrorMessage": "UnknownError",
  "ErrorCode": "UnknownError",
  "Result": true
}

Error codes

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

Change history

Change timeSummary of changesOperation
2023-09-17The internal configuration of the API is changed, but the call is not affectedView Change Details