user_roles

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

Overview

Name	user_roles
Type	Resource
Id	nvidia.orgs.user_roles

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
add	insert	user_email_or_id, roles		Invite if user does not exist, otherwise add role in org
remove	delete	user_email_or_id	roles	Remove role in org if user exists, otherwise remove invitation

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.

Name	Datatype	Description
roles	array
user_email_or_id	string
roles	array

INSERT examples

add

Invite if user does not exist, otherwise add role in org

INSERT INTO nvidia.orgs.user_roles (
user_email_or_id,
roles
)
SELECT 
'{{ user_email_or_id }}',
'{{ roles }}'
RETURNING
activation_token,
nca_role,
request_status,
user,
user_roles
;

Manifest

# Description fields are for documentation purposes
- name: user_roles
props:
  - name: user_email_or_id
    value: "{{ user_email_or_id }}"
    description: Required parameter for the user_roles resource.
  - name: roles
    value: "{{ roles }}"
    description: Required parameter for the user_roles resource.

DELETE examples

remove

Remove role in org if user exists, otherwise remove invitation

DELETE FROM nvidia.orgs.user_roles
WHERE user_email_or_id = '{{ user_email_or_id }}' --required
AND roles = '{{ roles }}'
;