Note

This documentation is for a prior release of Kinetica. For the latest documentation, click here.

/revoke/role

URL: http://<db.host>:<db.port>/revoke/role

Revokes membership in a role from a user or role.

Input Parameter Description

NameTypeDescription
rolestringName of the role in which membership will be revoked. Must be an existing role.
memberstringName of the user or role that will be revoked membership in input parameter role. Must be an existing user or role.
optionsmap of string to stringsOptional parameters. The default value is an empty map ( {} ).

Output Parameter Description

The GPUdb server embeds the endpoint response inside a standard response structure which contains status information and the actual response to the query. Here is a description of the various fields of the wrapper:

NameTypeDescription
statusString'OK' or 'ERROR'
messageStringEmpty if success or an error message
data_typeString'revoke_role_response' or 'none' in case of an error
dataStringEmpty string
data_strJSON or String

This embedded JSON represents the result of the /revoke/role endpoint:

NameTypeDescription
rolestringValue of input parameter role.
memberstringValue of input parameter member.
infomap of string to stringsAdditional information.

Empty string in case of an error.