/has/role

URL: https://<aws.fqdn>/<aws.cluster.name>/gpudb-0/has/role

Checks if the specified user has the specified role.

Input Parameter Description

NameTypeDescription
principalstringName 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 ''.
rolestringName of role to check for membership.
optionsmap of string to strings

Optional parameters. The default value is an empty map ( {} ).

Supported Parameters (keys)Parameter Description
no_error_if_not_exists

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
only_direct

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 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'has_role_response' or 'none' in case of an error
dataStringEmpty string
data_strJSON or String

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

NameTypeDescription
principalstringValue of input parameter principal
rolestringinput parameter role for which membership is being checked
has_roleboolean

Indicates whether the specified user has membership in the specified target input parameter role.

Possible ValuesDescription
trueUser has membership in the role
falseUser does not have membership in the role
infomap of string to strings

Additional information. The default value is an empty map ( {} ).

Possible Parameters (keys)Parameter Description
direct

true when principal is directly a member of the role. The default value is false. Possible values are:

  • true
  • false

Empty string in case of an error.