/show/security - Kinetica Docs

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

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.

map of string to strings

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

Show options

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

‘show_security_response’ or ‘none’ in case of an error

String

Empty string

JSON or String

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

Show data_str

map of string to strings

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

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.

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.

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.

map of string to strings

Map of user name to resource group name.

map of string to strings

Additional information.

Empty string in case of an error.

​Input Parameter Description

​Output Parameter Description

Input Parameter Description

Output Parameter Description