Skip to main content
show_security(names=None, options=)[source]

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.

Parameters

names (list of str) –

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. The user can provide a single element (which will be automatically promoted to a list internally) or a list.

options (dict of str to str) –

Optional parameters. Allowed keys are:

  • show_current_user – If true, returns only security information for the current user. Allowed values are:

    • true

    • false

    The default value is ‘false’.

The default value is an empty dict ( ).

Returns

A dict with the following entries–

types (dict of str to str) –

Map of user/role name to the type of that user/role. Allowed values are:

  • 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 (dict of str to lists of str) –

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

permissions (dict of str to lists of dicts of str to str) –

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

resource_groups (dict of str to str) –

Map of user name to resource group name.

info (dict of str to str) –

Additional information.