Grant

Grant the specified privilege(s) on the named securable to the named grantee (Deprecated)¶

POST/api/v2/grants/{granteeType}/{granteeName}/{securableType}/{securableName}/privileges
Endpoint to indicate that the privileges listed in the request body should be granted.

Path Parameters¶

ParameterDescription
granteeType string
String that specifies the type of resource that is the privilege grantee.
granteeName string
String that specifies the name of the privilege grantee.
securableType string
String that specifies the type of resource that is being secured by a privilege.
securableName string
String that specifies the name of resource that is being secured by a privilege.

Response¶

CodeDescription
200
Successful request.
202
Successfully accepted the request, but it is not completed yet.

Grant the specified privilege(s) on all/future (as specified by bulkGrantType) securables of this type in a given scope to the named grantee (Deprecated)¶

POST/api/v2/grants/{granteeType}/{granteeName}/{bulkGrantType}/{securableTypePlural}/{scopeType}/{scopeName}/privileges
Endpoint to indicate that the privileges listed in the request body should be granted to all securables of this type in the given scope.

Path Parameters¶

ParameterDescription
granteeType string
String that specifies the type of resource that is the privilege grantee.
granteeName string
String that specifies the name of the privilege grantee.
bulkGrantType string
String that species whether this group privilege should be on ALL or FUTURE resources of the specified plural type
securableTypePlural string
String that specifies the plural of the type of resource that is being secured by an ALL/FUTURE privilege. Must be either "schemas" or any plural object type that can nest under a schema such as "tables"
scopeType string
String that specifies the type of resource that is the scope of an ALL/FUTURE privilege. Can only be DATABASE or SCHEMA
scopeName string
String that specifies the name of resource that is the scope of an ALL/FUTURE privilege

Response¶

CodeDescription
200
Successful request.
202
Successfully accepted the request, but it is not completed yet.

Revoke the specified privilege on the named securable from the named grantee (Deprecated)¶

DELETE/api/v2/grants/{granteeType}/{granteeName}/{securableType}/{securableName}/privileges/{privilege}
Endpoint to indicate that the privilege listed in the path should be revoked.

Path Parameters¶

ParameterDescription
granteeType string
String that specifies the type of resource that is the privilege grantee.
granteeName string
String that specifies the name of the privilege grantee.
securableType string
String that specifies the type of resource that is being secured by a privilege.
securableName string
String that specifies the name of resource that is being secured by a privilege.
privilege string
String that specifies a privilege to be revoked

Query Parameters¶

ParameterDescription
deleteMode string
If "cascade", recursively revoke the grant from sub-grantees to which this privilege was re-granted. Acceptable values are "restrict" or "cascade".

Response¶

CodeDescription
200
Successful request.
202
Successfully accepted the request, but it is not completed yet.

Revoke the grant option for the specified privilege on the named securable from the named grantee (Deprecated)¶

DELETE/api/v2/grants/{granteeType}/{granteeName}/{securableType}/{securableName}/privileges/{privilege}/grant-option
Endpoint to indicate that the grant option for the privilege listed in the path should be revoked.

Path Parameters¶

ParameterDescription
granteeType string
String that specifies the type of resource that is the privilege grantee.
granteeName string
String that specifies the name of the privilege grantee.
securableType string
String that specifies the type of resource that is being secured by a privilege.
securableName string
String that specifies the name of resource that is being secured by a privilege.
privilege string
String that specifies a privilege to be revoked

Query Parameters¶

ParameterDescription
deleteMode string
If "cascade", recursively revoke the grant from sub-grantees to which this privilege was re-granted. Acceptable values are "restrict" or "cascade".

Response¶

CodeDescription
200
Successful request.
202
Successfully accepted the request, but it is not completed yet.

Revoke the specified privilege on the specified all/future securable in the given scope from the named grantee (Deprecated)¶

DELETE/api/v2/grants/{granteeType}/{granteeName}/{bulkGrantType}/{securableTypePlural}/{scopeType}/{scopeName}/privileges/{privilege}
Endpoint to indicate that the privilege listed on the group securable in the given scope should be revoked.

Path Parameters¶

ParameterDescription
granteeType string
String that specifies the type of resource that is the privilege grantee.
granteeName string
String that specifies the name of the privilege grantee.
bulkGrantType string
String that species whether this group privilege should be on ALL or FUTURE resources of the specified plural type
securableTypePlural string
String that specifies the plural of the type of resource that is being secured by an ALL/FUTURE privilege. Must be either "schemas" or any plural object type that can nest under a schema such as "tables"
scopeType string
String that specifies the type of resource that is the scope of an ALL/FUTURE privilege. Can only be DATABASE or SCHEMA
scopeName string
String that specifies the name of resource that is the scope of an ALL/FUTURE privilege
privilege string
String that specifies a privilege to be revoked

Query Parameters¶

ParameterDescription
deleteMode string
If "cascade", recursively revoke the grant from sub-grantees to which this privilege was re-granted. Acceptable values are "restrict" or "cascade".

Response¶

CodeDescription
200
Successful request.
202
Successfully accepted the request, but it is not completed yet.

Revoke the grant option for the specified privilege on the specified all/future securable in the given scope from the named grantee (Deprecated)¶

DELETE/api/v2/grants/{granteeType}/{granteeName}/{bulkGrantType}/{securableTypePlural}/{scopeType}/{scopeName}/privileges/{privilege}/grant-option
Endpoint to indicate that the grant option for the privilege listed on the group securable in the given scope should be revoked.

Path Parameters¶

ParameterDescription
granteeType string
String that specifies the type of resource that is the privilege grantee.
granteeName string
String that specifies the name of the privilege grantee.
bulkGrantType string
String that species whether this group privilege should be on ALL or FUTURE resources of the specified plural type
securableTypePlural string
String that specifies the plural of the type of resource that is being secured by an ALL/FUTURE privilege. Must be either "schemas" or any plural object type that can nest under a schema such as "tables"
scopeType string
String that specifies the type of resource that is the scope of an ALL/FUTURE privilege. Can only be DATABASE or SCHEMA
scopeName string
String that specifies the name of resource that is the scope of an ALL/FUTURE privilege
privilege string
String that specifies a privilege to be revoked

Query Parameters¶

ParameterDescription
deleteMode string
If "cascade", recursively revoke the grant from sub-grantees to which this privilege was re-granted. Acceptable values are "restrict" or "cascade".

Response¶

CodeDescription
200
Successful request.
202
Successfully accepted the request, but it is not completed yet.

List of privileges associated with this grantee type and name (Deprecated)¶

GET/api/v2/grants/{granteeType}/{granteeName}
List the roles and privileges granted to the specified grantee using the output of SHOW GRANTS TO

Path Parameters¶

ParameterDescription
granteeType string
String that specifies the type of resource that is the privilege grantee.
granteeName string
String that specifies the name of the privilege grantee.

Query Parameters¶

ParameterDescription
showLimit integer
Query parameter to limit the maximum number of rows returned by a command.

Response¶

CodeDescription
200
successful
202
Successfully accepted the request, but it is not completed yet.
Language: English