Skip to main content

roles

Creates, updates, deletes, gets or lists a roles resource.

Overview​

Nameroles
TypeResource
Idnvidia.orgs.roles

Fields​

The following fields are returned by SELECT queries:

NameDatatypeDescription
namestringName of the role
display_namestringDisplay Name of the role (wire: displayName)
short_display_namestringShort Display Name of the role (wire: shortDisplayName)
allowed_actionsarrayList of actions that this role allows (wire: allowedActions)
productobjectProduct information of the role

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
listselectshow_hiddenList of roles in NGC and their scopes

Parameters​

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
show_hiddenbooleanflag indicate if hidden roles should be included

SELECT examples​

List of roles in NGC and their scopes

SELECT
name,
display_name,
short_display_name,
allowed_actions,
product
FROM nvidia.orgs.roles
WHERE show_hidden = '{{ show_hidden }}'
;