All Products
Search
Document Center

Data Lake Formation:GrantRoleToUsers

Last Updated:Apr 01, 2025

Grant a Data Lake role to multiple users.

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:
    • For mandatory resource types, indicate with a prefix of * .
    • 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
dlf:GrantRoleToUserscreate
*All Resources
*
    none
none

Request syntax

PUT /api/metastore/auth/roles/grantusers HTTP/1.1

Request parameters

ParameterTypeRequiredDescriptionExample
bodyobjectNo

The HTTP request body.

RoleNamestringNo

The name of the role.

test_role_8
UsersPrincipalsNo

The RAM users or roles to which you want to assign the role. Format:

  • RAM user: acs:ram::[accountId]:user/[userName].
  • RAM role: acs:ram::[accountId]:role/[roleName].

Response parameters

ParameterTypeDescriptionExample
object

Returns the message body.

RequestIdstring

The request ID.

4316D7DA-9816-596D-A3D7-12676FA59BDA
Codestring

The returned message.

OK
Messagestring

The response message.

.
Successboolean

Indicates whether the request was successful. Valid values: Valid values:

  • true: The request was successful.
  • false
true

Examples

Sample success responses

JSONformat

{
  "RequestId": "4316D7DA-9816-596D-A3D7-12676FA59BDA",
  "Code": "OK",
  "Message": ".",
  "Success": true
}

Error codes

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

Change history

Change timeSummary of changesOperation
No change history