teams

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

Overview

Name	teams
Type	Resource
Id	nvidia.orgs.teams

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	integer (int64)	unique Id of this team.
name	string	team name
description	string	description of the team
infinity_manager_settings	object	Infinity manager setting definition (wire: infinityManagerSettings)
is_deleted	boolean	indicates if the team is deleted or not (wire: isDeleted)
repo_scan_settings	object	Repo scan setting definition (wire: repoScanSettings)

list

Name	Datatype	Description
id	integer (int64)	unique Id of this team.
name	string	team name
description	string	description of the team
infinity_manager_settings	object	Infinity manager setting definition (wire: infinityManagerSettings)
is_deleted	boolean	indicates if the team is deleted or not (wire: isDeleted)
repo_scan_settings	object	Repo scan setting definition (wire: repoScanSettings)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	team_name		Get Team by name
list	select		page_number, page_size	List all Teams
create	insert	name		Create team in org. (Org Admin Privileges Required)
update	update	team_name		Edit a Team
delete	delete	team_name		Delete a 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
team_name	string
page_number	integer (int32)	The page number of result
page_size	integer (int32)	The page size of result

SELECT examples

get

Get Team by name

SELECT
id,
name,
description,
infinity_manager_settings,
is_deleted,
repo_scan_settings
FROM nvidia.orgs.teams
WHERE team_name = '{{ team_name }}' -- required
;

list

List all Teams

SELECT
id,
name,
description,
infinity_manager_settings,
is_deleted,
repo_scan_settings
FROM nvidia.orgs.teams
WHERE page_number = '{{ page_number }}'
AND page_size = '{{ page_size }}'
;

INSERT examples

create

Create team in org. (Org Admin Privileges Required)

INSERT INTO nvidia.orgs.teams (
description,
name
)
SELECT 
'{{ description }}',
'{{ name }}' /* required */
RETURNING
request_status,
team
;

Manifest

# Description fields are for documentation purposes
- name: teams
props:
  - name: description
    value: "{{ description }}"
    description: |
      description of the team
  - name: name
    value: "{{ name }}"
    description: |
      team name

UPDATE examples

update

Edit a Team

UPDATE nvidia.orgs.teams
SET 
description = '{{ description }}',
infinity_manager_settings = '{{ infinity_manager_settings }}',
repo_scan_settings = '{{ repo_scan_settings }}'
WHERE 
team_name = '{{ team_name }}' --required
RETURNING
request_status,
team;

DELETE examples

delete

Delete a Team

DELETE FROM nvidia.orgs.teams
WHERE team_name = '{{ team_name }}' --required
;