Modifying Database Object Permissions

Function

This API is used to modify database object permissions.

Calling Method

For details, see Calling APIs.

URI

POST /v1/{project_id}/clusters/{cluster_id}/db-manager/authority

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID. To obtain the value, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A
cluster_id	Yes	String	Definition Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID. Constraints N/A Range N/A Default Value N/A

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
type	Yes	String	Definition Object type. Range DATABASE, SCHEMA, TABLE, VIEW, COLUMN, FUNCTION, SEQUENCE, NODEGROUP, or ROLE.
is_grant	Yes	Boolean	Definition Whether to grant a permission. Range N/A
grant_list	No	Array of Grant objects	Definition List of granted permissions. This parameter is mandatory when is_grant is set to true. Range N/A
revoke_list	No	Array of Revoke objects	Definition List of revoked permissions. This parameter is mandatory when is_grant is set to false. Range N/A
role_list	Yes	Array of strings	Definition List of roles that a permission is granted. Range N/A
object_list	Yes	Array of strings	Definition List of objects to which a permission belongs. Range N/A
all_object	No	Boolean	Definition Permissions on all database objects in a schema. The default value is false. Range N/A
cascade	No	Boolean	Definition Whether a permission is revoked in cascading mode. The default value is true. Range N/A
database	Yes	String	Definition Database name. Range N/A
schema	No	String	Definition Schema name. Range N/A
table	No	String	Definition Table name. Range N/A

**Table 3** Grant
Parameter	Mandatory	Type	Description
permission	Yes	String	Definition Permission name. The permission varies depending on the database object type. Range For database: CREATE \| CONNECT \| TEMPORARY \| TEMP ALL PRIVILEGES For schemas: CREATE, USAGE, ALTER, or DROP ALL PRIVILEGES For tables: SELECT, INSERT, UPDATE, DELETE, TRUNCATE, REFERENCES, TRIGGER, ANALYZE, ANALYSE, VACUUM, ALTER, or DROP ALL PRIVILEGES For views: SELECT, INSERT, UPDATE, DELETE, TRUNCATE, REFERENCES, TRIGGER, ANALYZE, ANALYSE, VACUUM, ALTER, or DROP ALL PRIVILEGES For columns: SELECT, INSERT, UPDATE, or REFERENCES ALL PRIVILEGES For functions: EXECUTE ALL PRIVILEGES For sequences: SELECT, UPDATE, or USAGE ALL PRIVILEGES For node groups: CREATE, USAGE, or COMPUTE ALL PRIVILEGES For roles: If role_name is specified, all the permissions of this role are given to a user.
grant_with	Yes	Boolean	Definition Whether a permission is included in the grant options. Range N/A

**Table 4** Revoke
Parameter	Mandatory	Type	Description
permission	Yes	String	Definition Permission name. The permission varies depending on the database object type. Range For database: CREATE \| CONNECT \| TEMPORARY \| TEMP ALL PRIVILEGES For schemas: CREATE, USAGE, ALTER, or DROP ALL PRIVILEGES For tables: SELECT, INSERT, UPDATE, DELETE, TRUNCATE, REFERENCES, TRIGGER, ANALYZE, ANALYSE, VACUUM, ALTER, or DROP ALL PRIVILEGES For views: SELECT, INSERT, UPDATE, DELETE, TRUNCATE, REFERENCES, TRIGGER, ANALYZE, ANALYSE, VACUUM, ALTER, or DROP ALL PRIVILEGES For columns: SELECT, INSERT, UPDATE, or REFERENCES ALL PRIVILEGES For functions: EXECUTE ALL PRIVILEGES For sequences: SELECT, UPDATE, or USAGE ALL PRIVILEGES For node groups: CREATE, USAGE, or COMPUTE ALL PRIVILEGES For roles: If role_name is specified, all the permissions of this role are given to a user.
revoke_with	Yes	Boolean	Definition Whether to remove a grant option. Range N/A

Response Parameters

Status code: 200

**Table 5** Response body parameters
Parameter	Type	Description
view_sql	Array of strings	Definition SQL list. Range N/A

Example Requests

Modify the database object permission of the cluster whose ID is a89aea88-7ea2-40bd-8ac8-8b93e169e5d6. Specifically, grant the SELECT permission of table1 and table2 in a GaussDB database to user1 and user2 in the schema public.

POST https://{Endpoint}/v1/0536cdee2200d5912f7cc00b877980f1/clusters/a89aea88-7ea2-40bd-8ac8-8b93e169e5d6/db-manager/authority

{
  "type" : "table",
  "is_grant" : true,
  "grant_list" : [ {
    "permission" : "SELECT",
    "grant_with" : true
  } ],
  "role_list" : [ "user1", "user2" ],
  "object_list" : [ "table1", "table2" ],
  "database" : "gaussdb",
  "schema" : "public"
}

Example Responses

Status code: 200

Modification succeeded.

{
  "view_sql" : [ "GRANT SELECT ON TABLE public.test_t1 TO user1 WITH GRANT OPTION;", "GRANT UPDATE ON TABLE public.test_t1 TO user1 ;" ]
}

Status Codes

Status Code	Description
200	Modification succeeded.
400	Request error.
401	Authentication failed.
403	You do not have required permissions.
404	No resources found.
500	Internal server error.
503	Service unavailable.