Checks if the specified user has the specified role.
Input Parameter Description
string
Name of the user for which role membership is being checked. Must be an existing user. If blank, will use the current user.The default value is ”.
string
Name of role to check for membership.
map of string to strings
Optional parameters.The default value is an empty map ( {} ).
Show options
If false will return an error if the provided input parameter role does not exist or is blank. If true then it will return false for output parameter has_role.The default value is false.The supported values are:
true
false
If false will search recursively if the input parameter principal is a member of input parameter role. If true then input parameter principal must directly be a member of input parameter role.The default value is false.The supported values are:
true
false
Output Parameter Description
The Kinetica 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:
String
‘OK’ or ‘ERROR’
String
Empty if success or an error message
String
‘has_role_response’ or ‘none’ in case of an error
String
Empty string
JSON or String
This embedded JSON represents the result of the /has/role endpoint:
Show data_str
string
Value of input parameter principal.
string
Input parameter role for which membership is being checked.
boolean
Indicates whether the specified user has membership in the specified target input parameter role.
true: User has membership in the role.
false: User does not have membership in the role.
map of string to strings
Additional information.The default value is an empty map ( {} ).
Show info
true when principal is directly a member of the role.The default value is false.The supported values are:
true
false
Empty string in case of an error.
Assistant
Responses are generated using AI and may contain mistakes.