proto_orgs

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

Overview

Name	proto_orgs
Type	Resource
Id	nvidia.orgs.proto_orgs

Fields

The following fields are returned by SELECT queries:

validate

Name	Datatype	Description
proto_org_id	string	Proto Org identifier. (wire: protoOrgId)
email	string	Email address of the user.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
validate	select	invitation_token		Validate org creation from proto org
create	insert			Create a new organization based on the org info retrieved from the ProtoOrg.

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
invitation_token	string	JWT that contains org owner email and proto org identifier

SELECT examples

validate

Validate org creation from proto org

SELECT
proto_org_id,
email
FROM nvidia.orgs.proto_orgs
WHERE invitation_token = '{{ invitation_token }}' -- required
;

INSERT examples

create

Create a new organization based on the org info retrieved from the ProtoOrg.

INSERT INTO nvidia.orgs.proto_orgs (
country,
description,
display_name,
initiator,
is_internal,
name,
nca_id,
nca_number,
org_owner,
pec_name,
pec_sfdc_id,
product_enablements,
product_subscriptions,
proto_org_id,
salesforce_account_industry,
send_email,
type
)
SELECT 
'{{ country }}',
'{{ description }}',
'{{ display_name }}',
'{{ initiator }}',
{{ is_internal }},
'{{ name }}',
'{{ nca_id }}',
'{{ nca_number }}',
'{{ org_owner }}',
'{{ pec_name }}',
'{{ pec_sfdc_id }}',
'{{ product_enablements }}',
'{{ product_subscriptions }}',
'{{ proto_org_id }}',
'{{ salesforce_account_industry }}',
{{ send_email }},
'{{ type }}'
RETURNING
organizations,
request_status
;

Manifest

# Description fields are for documentation purposes
- name: proto_orgs
props:
  - name: country
    value: "{{ country }}"
    description: |
      user country
  - name: description
    value: "{{ description }}"
    description: |
      optional description of the organization
  - name: display_name
    value: "{{ display_name }}"
    description: |
      Name of the organization that will be shown to users.
  - name: initiator
    value: "{{ initiator }}"
    description: |
      Identify the initiator of the org request
  - name: is_internal
    value: {{ is_internal }}
    description: |
      Is NVIDIA internal org or not
  - name: name
    value: "{{ name }}"
    description: |
      Organization name
  - name: nca_id
    value: "{{ nca_id }}"
    description: |
      NVIDIA Cloud Account Identifier
  - name: nca_number
    value: "{{ nca_number }}"
    description: |
      NVIDIA Cloud Account Number
  - name: org_owner
    description: |
      Org owner.
    value:
      email: "{{ email }}"
      fullName: "{{ fullName }}"
      idpId: "{{ idpId }}"
      starfleetId: "{{ starfleetId }}"
  - name: pec_name
    value: "{{ pec_name }}"
    description: |
      product end customer name for enterprise(Fleet Command) product
  - name: pec_sfdc_id
    value: "{{ pec_sfdc_id }}"
    description: |
      product end customer salesforce.com Id (external customer Id) for enterprise(Fleet Command) product
  - name: product_enablements
    value:
      - expirationDate: "{{ expirationDate }}"
        poDetails: "{{ poDetails }}"
        productName: "{{ productName }}"
        type: "{{ type }}"
  - name: product_subscriptions
    description: |
      This should be deprecated, use productEnablements instead
    value:
      - emsEntitlementType: "{{ emsEntitlementType }}"
        expirationDate: "{{ expirationDate }}"
        id: "{{ id }}"
        productName: "{{ productName }}"
        startDate: "{{ startDate }}"
        type: "{{ type }}"
  - name: proto_org_id
    value: "{{ proto_org_id }}"
    description: |
      Proto org identifier
  - name: salesforce_account_industry
    value: "{{ salesforce_account_industry }}"
    description: |
      Company or organization industry
  - name: send_email
    value: {{ send_email }}
    description: |
      Send email to org owner or not. Default is true
  - name: type
    value: "{{ type }}"
    valid_values: ['UNKNOWN', 'CLOUD', 'ENTERPRISE', 'INDIVIDUAL']