/show/security

URL: http://<db.host>:<db.port>/show/security

Shows security information relating to users and/or roles. If the caller is not a system administrator, only information relating to the caller and their roles is returned.

Input Parameter Description

NameTypeDescription
namesarray of stringsA list of names of users and/or roles about which security information is requested. If none are provided, information about all users and roles will be returned.
optionsmap of string to strings

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

Supported Parameters (keys)Parameter Description
show_current_user

If true, returns only security information for the current user. 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'show_security_response' or 'none' in case of an error
dataStringEmpty string
data_strJSON or String

This embedded JSON represents the result of the /show/security endpoint:

NameTypeDescription
typesmap of string to strings

Map of user/role name to the type of that user/role.

Possible ValuesDescription
internal_userA user whose credentials are managed by the database system.
external_userA user whose credentials are managed by an external LDAP.
roleA role.
rolesmap of string to arrays of stringsMap of user/role name to a list of names of roles of which that user/role is a member.
permissionsmap of string to arrays of maps of string to stringsMap of user/role name to a list of permissions directly granted to that user/role.
resource_groupsmap of string to stringsMap of user name to resource group name.
infomap of string to stringsAdditional information.

Empty string in case of an error.