team_members

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

Overview

Name	team_members
Type	Resource
Id	nvidia.orgs.team_members

Fields

The following fields are returned by SELECT queries:

get_by_starfleet_id

Name	Datatype	Description
activation_token	string	token needed to activate the user to enable login and other features (wire: activationToken)
nca_role	string	NCA role (UNKNOWN, ADMINISTRATOR, MEMBER, OWNER, PENDING) (wire: ncaRole)
request_status	object	(wire: requestStatus)
user	object	information about the user
user_roles	array	DEPRECATED - Please use roles inside user (wire: userRoles)

get

Name	Datatype	Description
activation_token	string	token needed to activate the user to enable login and other features (wire: activationToken)
nca_role	string	NCA role (UNKNOWN, ADMINISTRATOR, MEMBER, OWNER, PENDING) (wire: ncaRole)
request_status	object	(wire: requestStatus)
user	object	information about the user
user_roles	array	DEPRECATED - Please use roles inside user (wire: userRoles)

list

Name	Datatype	Description
id	integer (int64)	unique Id of this user.
name	string	user name
client_id	string	unique auth client id of this user. (wire: clientId)
starfleet_id	string	unique starfleet id of this user. (wire: starfleetId)
created_date	string	Created date for this user (wire: createdDate)
email	string	Email address of the user. This should be unique.
first_login_date	string	Last time the user logged in (wire: firstLoginDate)
has_beta_access	boolean	Determines if the user has beta access (wire: hasBetaAccess)
has_profile	boolean	indicate if user profile has been completed. (wire: hasProfile)
has_signed_ai_foundry_partnerships_eula	boolean	indicates if user has accepted AI Foundry Partnerships eula (wire: hasSignedAiFoundryPartnershipsEULA)
has_signed_aodteula	boolean	indicates if user has accepted AODT End User License Agreement. (wire: hasSignedAODTEULA)
has_signed_base_command_eula	boolean	indicates if user has accepted Base Command End User License Agreement. (wire: hasSignedBaseCommandEULA)
has_signed_base_command_manager_eula	boolean	indicates if user has accepted Base Command Manager End User License Agreement. (wire: hasSignedBaseCommandManagerEULA)
has_signed_bio_ne_mo_eula	boolean	indicates if user has accepted BioNeMo End User License Agreement. (wire: hasSignedBioNeMoEULA)
has_signed_container_publishing_eula	boolean	indicates if user has accepted container publishing eula (wire: hasSignedContainerPublishingEULA)
has_signed_cu_opt_eula	boolean	indicates if user has accepted CuOpt eula (wire: hasSignedCuOptEULA)
has_signed_earth_2_eula	boolean	indicates if user has accepted Earth-2 eula (wire: hasSignedEarth2EULA)
has_signed_egx_eula	boolean	[Deprecated] indicates if user has accepted EGX End User License Agreement. (wire: hasSignedEgxEULA)
has_signed_eula	boolean	Determines if the user has signed the NGC End User License Agreement. (wire: hasSignedEULA)
has_signed_fleet_command_eula	boolean	indicates if user has accepted Fleet Command End User License Agreement. (wire: hasSignedFleetCommandEULA)
has_signed_llm_eula	boolean	indicates if user has accepted LLM End User License Agreement. (wire: hasSignedLlmEULA)
has_signed_nvaieeula	boolean	indicates if user has accepted Fleet Command End User License Agreement. (wire: hasSignedNVAIEEULA)
has_signed_nvidia_eula	boolean	Determines if the user has signed the NVIDIA End User License Agreement. (wire: hasSignedNvidiaEULA)
has_signed_nvqceula	boolean	indicates if user has accepted Nvidia Quantum Cloud End User License Agreement. (wire: hasSignedNVQCEULA)
has_signed_omniverse_eula	boolean	indicates if user has accepted Omniverse End User License Agreement. (wire: hasSignedOmniverseEULA)
has_signed_privacy_policy	boolean	Determines if the user has signed the Privacy Policy. (wire: hasSignedPrivacyPolicy)
has_signed_third_party_registry_share_eula	boolean	indicates if user has consented to share their registration info with other parties (wire: hasSignedThirdPartyRegistryShareEULA)
has_subscribed_to_email	boolean	Determines if the user has opted in email subscription. (wire: hasSubscribedToEmail)
idp_type	string	Type of IDP, Identity Provider. Used for login. (NVIDIA, ENTERPRISE) (wire: idpType)
is_active	boolean	Determines if the user is active or not. (wire: isActive)
is_deleted	boolean	Indicates if user was deleted from the system. (wire: isDeleted)
is_saml	boolean	Determines if the user is a SAML account or not. (wire: isSAML)
job_position_title	string	Title of user's job position. (wire: jobPositionTitle)
last_login_date	string	Last time the user logged in (wire: lastLoginDate)
roles	array	List of roles that the user have
storage_quota	array	Storage quota for this user. (wire: storageQuota)
updated_date	string	Updated date for this user (wire: updatedDate)
user_metadata	object	Metadata information about the user. (wire: userMetadata)
verified	boolean	Is user's email or phone number is verified

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_by_starfleet_id	select	team_name, starfleet_id		Get User details in team by starfleet Id
get	select	team_name, user_email_or_id		Get info and role/invitation in a team by email or id
list	select	team_name	page_number, page_size, q	Get list of users in team. (User Admin in team privileges required)
add	insert	team_name, id		Add a User to team
create	insert	team_name, email	send_email, idp_id	Creates a User and add them to a team within the org.
remove	delete	team_name, id	anonymize	Remove User from team.

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
id	string
starfleet_id	string
team_name	string
user_email_or_id	string
anonymize	boolean	If anonymize is true, then org owner permission is required.
idp_id	string	If the IDP ID is provided then it is used instead of the one configured for the organization
page_number	integer (int32)	The page number of result
page_size	integer (int32)	The page size of result
q	object	User Search Parameters. Only 'filters' and 'orderBy' for 'name' and 'email' are implemented
send_email	boolean

SELECT examples

get_by_starfleet_id

Get User details in team by starfleet Id

SELECT
activation_token,
nca_role,
request_status,
user,
user_roles
FROM nvidia.orgs.team_members
WHERE team_name = '{{ team_name }}' -- required
AND starfleet_id = '{{ starfleet_id }}' -- required
;

get

Get info and role/invitation in a team by email or id

SELECT
activation_token,
nca_role,
request_status,
user,
user_roles
FROM nvidia.orgs.team_members
WHERE team_name = '{{ team_name }}' -- required
AND user_email_or_id = '{{ user_email_or_id }}' -- required
;

list

Get list of users in team. (User Admin in team privileges required)

SELECT
id,
name,
client_id,
starfleet_id,
created_date,
email,
first_login_date,
has_beta_access,
has_profile,
has_signed_ai_foundry_partnerships_eula,
has_signed_aodteula,
has_signed_base_command_eula,
has_signed_base_command_manager_eula,
has_signed_bio_ne_mo_eula,
has_signed_container_publishing_eula,
has_signed_cu_opt_eula,
has_signed_earth_2_eula,
has_signed_egx_eula,
has_signed_eula,
has_signed_fleet_command_eula,
has_signed_llm_eula,
has_signed_nvaieeula,
has_signed_nvidia_eula,
has_signed_nvqceula,
has_signed_omniverse_eula,
has_signed_privacy_policy,
has_signed_third_party_registry_share_eula,
has_subscribed_to_email,
idp_type,
is_active,
is_deleted,
is_saml,
job_position_title,
last_login_date,
roles,
storage_quota,
updated_date,
user_metadata,
verified
FROM nvidia.orgs.team_members
WHERE team_name = '{{ team_name }}' -- required
AND page_number = '{{ page_number }}'
AND page_size = '{{ page_size }}'
AND q = '{{ q }}'
;

INSERT examples

add

Add a User to team

INSERT INTO nvidia.orgs.team_members (
team_name,
id
)
SELECT 
'{{ team_name }}',
'{{ id }}'
RETURNING
request_status
;

create

Creates a User and add them to a team within the org.

INSERT INTO nvidia.orgs.team_members (
email,
email_opt_in,
eula_accepted,
name,
role_type,
role_types,
salesforce_contact_job_role,
user_metadata,
team_name,
send_email,
idp_id
)
SELECT 
'{{ email }}' /* required */,
{{ email_opt_in }},
{{ eula_accepted }},
'{{ name }}',
'{{ role_type }}',
'{{ role_types }}',
'{{ salesforce_contact_job_role }}',
'{{ user_metadata }}',
'{{ team_name }}',
'{{ send_email }}',
'{{ idp_id }}'
RETURNING
activation_token,
nca_role,
request_status,
user,
user_roles
;

Manifest

# Description fields are for documentation purposes
- name: team_members
props:
  - name: team_name
    value: "{{ team_name }}"
    description: Required parameter for the team_members resource.
  - name: id
    value: "{{ id }}"
    description: Required parameter for the team_members resource.
  - name: email
    value: "{{ email }}"
    description: |
      Email address of the user. This should be unique.
  - name: email_opt_in
    value: {{ email_opt_in }}
    description: |
      indicates if user has opt in to nvidia emails
  - name: eula_accepted
    value: {{ eula_accepted }}
    description: |
      indicates if user has accepted EULA
  - name: name
    value: "{{ name }}"
    description: |
      user name
  - name: role_type
    value: "{{ role_type }}"
    description: |
      DEPRECATED - use roleTypes which allows multiple roles
  - name: role_types
    value:
      - "{{ role_types }}"
    description: |
      feature roles to give to the user
  - name: salesforce_contact_job_role
    value: "{{ salesforce_contact_job_role }}"
    description: |
      user job role
  - name: user_metadata
    description: |
      Metadata information about the user.
    value:
      company: "{{ company }}"
      companyUrl: "{{ companyUrl }}"
      country: "{{ country }}"
      firstName: "{{ firstName }}"
      industry: "{{ industry }}"
      interest:
        - "{{ interest }}"
      lastName: "{{ lastName }}"
      role: "{{ role }}"
  - name: send_email
    value: {{ send_email }}
  - name: idp_id
    value: "{{ idp_id }}"
    description: If the IDP ID is provided then it is used instead of the one configured for the organization
    description: If the IDP ID is provided then it is used instead of the one configured for the organization

DELETE examples

remove

Remove User from team.

DELETE FROM nvidia.orgs.team_members
WHERE team_name = '{{ team_name }}' --required
AND id = '{{ id }}' --required
AND anonymize = '{{ anonymize }}'
;