Note

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

/show/security

URL: https://<aws.fqdn>/<aws.cluster.name>/gpudb-0/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

Name

Type

Description

names

array of strings

A 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.

options

map 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:

Name

Type

Description

status

String

'OK' or 'ERROR'

message

String

Empty if success or an error message

data_type

String

'show_security_response' or 'none' in case of an error

data

String

Empty string

data_str

JSON or String

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

Name

Type

Description

types

map of string to strings

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

Possible Values	Description
internal_user	A user whose credentials are managed by the database system.
external_user	A user whose credentials are managed by an external LDAP.
role	A role.

roles

map of string to arrays of strings

Map of user/role name to a list of names of roles of which that user/role is a member.

permissions

map of string to arrays of maps of string to strings

Map of user/role name to a list of permissions directly granted to that user/role.

resource_groups

map of string to strings

Map of user name to resource group name.

info

map of string to strings

Additional information.

Empty string in case of an error.