ngc

package module
v0.0.0-...-d408665 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 11, 2024 License: Apache-2.0 Imports: 16 Imported by: 0

README

Ngc Go API Library

Go Reference

The Ngc Go library provides convenient access to the Ngc REST API from applications written in Go. The full API of this library can be found in api.md.

It is generated with Stainless.

Installation

import (
	"github.com/NVIDIADemo/ngc-go" // imported as ngc
)

Or to pin the version:

go get -u 'github.com/NVIDIADemo/ngc-go@v0.0.1-alpha.0'

Requirements

This library requires Go 1.18+.

Usage

The full API of this library can be found in api.md.

package main

import (
	"context"
	"fmt"

	"github.com/NVIDIADemo/ngc-go"
	"github.com/NVIDIADemo/ngc-go/option"
)

func main() {
	client := ngc.NewClient(
		option.WithAuthToken("My Auth Token"), // defaults to os.LookupEnv("NVCF_AUTH_TOKEN")
	)
	orgResponse, err := client.Orgs.New(context.TODO(), ngc.OrgNewParams{})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", orgResponse.Organizations)
}
Request fields

All request parameters are wrapped in a generic Field type, which we use to distinguish zero values from null or omitted fields.

This prevents accidentally sending a zero value if you forget a required parameter, and enables explicitly sending null, false, '', or 0 on optional parameters. Any field not specified is not sent.

To construct fields with values, use the helpers String(), Int(), Float(), or most commonly, the generic F[T](). To send a null, use Null[T](), and to send a nonconforming value, use Raw[T](any). For example:

params := FooParams{
	Name: ngc.F("hello"),

	// Explicitly send `"description": null`
	Description: ngc.Null[string](),

	Point: ngc.F(ngc.Point{
		X: ngc.Int(0),
		Y: ngc.Int(1),

		// In cases where the API specifies a given type,
		// but you want to send something else, use `Raw`:
		Z: ngc.Raw[int64](0.01), // sends a float
	}),
}
Response objects

All fields in response structs are value types (not pointers or wrappers).

If a given field is null, not present, or invalid, the corresponding field will simply be its zero value.

All response structs also include a special JSON field, containing more detailed information about each property, which you can use like so:

if res.Name == "" {
	// true if `"name"` is either not present or explicitly null
	res.JSON.Name.IsNull()

	// true if the `"name"` key was not present in the repsonse JSON at all
	res.JSON.Name.IsMissing()

	// When the API returns data that cannot be coerced to the expected type:
	if res.JSON.Name.IsInvalid() {
		raw := res.JSON.Name.Raw()

		legacyName := struct{
			First string `json:"first"`
			Last  string `json:"last"`
		}{}
		json.Unmarshal([]byte(raw), &legacyName)
		name = legacyName.First + " " + legacyName.Last
	}
}

These .JSON structs also include an Extras map containing any properties in the json response that were not specified in the struct. This can be useful for API features not yet present in the SDK.

body := res.JSON.ExtraFields["my_unexpected_field"].Raw()
RequestOptions

This library uses the functional options pattern. Functions defined in the option package return a RequestOption, which is a closure that mutates a RequestConfig. These options can be supplied to the client or at individual requests. For example:

client := ngc.NewClient(
	// Adds a header to every request made by the client
	option.WithHeader("X-Some-Header", "custom_header_info"),
)

client.Orgs.New(context.TODO(), ...,
	// Override the header
	option.WithHeader("X-Some-Header", "some_other_custom_header_info"),
	// Add an undocumented field to the request body, using sjson syntax
	option.WithJSONSet("some.json.path", map[string]string{"my": "object"}),
)

See the full list of request options.

Pagination

This library provides some conveniences for working with paginated list endpoints.

You can use .ListAutoPaging() methods to iterate through items across all pages:

iter := client.Orgs.ListAutoPaging(context.TODO(), ngc.OrgListParams{})
// Automatically fetches more pages as needed.
for iter.Next() {
	orgListResponse := iter.Current()
	fmt.Printf("%+v\n", orgListResponse)
}
if err := iter.Err(); err != nil {
	panic(err.Error())
}

Or you can use simple .List() methods to fetch a single page and receive a standard response object with additional helper methods like .GetNextPage(), e.g.:

page, err := client.Orgs.List(context.TODO(), ngc.OrgListParams{})
for page != nil {
	for _, org := range page.Organizations {
		fmt.Printf("%+v\n", org)
	}
	page, err = page.GetNextPage()
}
if err != nil {
	panic(err.Error())
}
Errors

When the API returns a non-success status code, we return an error with type *ngc.Error. This contains the StatusCode, *http.Request, and *http.Response values of the request, as well as the JSON of the error body (much like other response objects in the SDK).

To handle errors, we recommend that you use the errors.As pattern:

_, err := client.Orgs.New(context.TODO(), ngc.OrgNewParams{})
if err != nil {
	var apierr *ngc.Error
	if errors.As(err, &apierr) {
		println(string(apierr.DumpRequest(true)))  // Prints the serialized HTTP request
		println(string(apierr.DumpResponse(true))) // Prints the serialized HTTP response
	}
	panic(err.Error()) // GET "/v3/orgs": 400 Bad Request { ... }
}

When other errors occur, they are returned unwrapped; for example, if HTTP transport fails, you might receive *url.Error wrapping *net.OpError.

Timeouts

Requests do not time out by default; use context to configure a timeout for a request lifecycle.

Note that if a request is retried, the context timeout does not start over. To set a per-retry timeout, use option.WithRequestTimeout().

// This sets the timeout for the request, including all the retries.
ctx, cancel := context.WithTimeout(context.Background(), 5*time.Minute)
defer cancel()
client.Orgs.New(
	ctx,
	ngc.OrgNewParams{},
	// This sets the per-retry timeout
	option.WithRequestTimeout(20*time.Second),
)
File uploads

Request parameters that correspond to file uploads in multipart requests are typed as param.Field[io.Reader]. The contents of the io.Reader will by default be sent as a multipart form part with the file name of "anonymous_file" and content-type of "application/octet-stream".

The file name and content-type can be customized by implementing Name() string or ContentType() string on the run-time type of io.Reader. Note that os.File implements Name() string, so a file returned by os.Open will be sent with the file name on disk.

We also provide a helper ngc.FileParam(reader io.Reader, filename string, contentType string) which can be used to wrap any io.Reader with the appropriate file name and content type.

Retries

Certain errors will be automatically retried 2 times by default, with a short exponential backoff. We retry by default all connection errors, 408 Request Timeout, 409 Conflict, 429 Rate Limit, and >=500 Internal errors.

You can use the WithMaxRetries option to configure or disable this:

// Configure the default for all requests:
client := ngc.NewClient(
	option.WithMaxRetries(0), // default is 2
)

// Override per-request:
client.Orgs.New(
	context.TODO(),
	ngc.OrgNewParams{},
	option.WithMaxRetries(5),
)
Making custom/undocumented requests

This library is typed for convenient access to the documented API. If you need to access undocumented endpoints, params, or response properties, the library can still be used.

Undocumented endpoints

To make requests to undocumented endpoints, you can use client.Get, client.Post, and other HTTP verbs. RequestOptions on the client, such as retries, will be respected when making these requests.

var (
    // params can be an io.Reader, a []byte, an encoding/json serializable object,
    // or a "…Params" struct defined in this library.
    params map[string]interface{}

    // result can be an []byte, *http.Response, a encoding/json deserializable object,
    // or a model defined in this library.
    result *http.Response
)
err := client.Post(context.Background(), "/unspecified", params, &result)
if err != nil {
    …
}
Undocumented request params

To make requests using undocumented parameters, you may use either the option.WithQuerySet() or the option.WithJSONSet() methods.

params := FooNewParams{
    ID:   ngc.F("id_xxxx"),
    Data: ngc.F(FooNewParamsData{
        FirstName: ngc.F("John"),
    }),
}
client.Foo.New(context.Background(), params, option.WithJSONSet("data.last_name", "Doe"))
Undocumented response properties

To access undocumented response properties, you may either access the raw JSON of the response as a string with result.JSON.RawJSON(), or get the raw JSON of a particular field on the result with result.JSON.Foo.Raw().

Any fields that are not present on the response struct will be saved and can be accessed by result.JSON.ExtraFields() which returns the extra fields as a map[string]Field.

Middleware

We provide option.WithMiddleware which applies the given middleware to requests.

func Logger(req *http.Request, next option.MiddlewareNext) (res *http.Response, err error) {
	// Before the request
	start := time.Now()
	LogReq(req)

	// Forward the request to the next handler
	res, err = next(req)

	// Handle stuff after the request
	end := time.Now()
	LogRes(res, err, start - end)

    return res, err
}

client := ngc.NewClient(
	option.WithMiddleware(Logger),
)

When multiple middlewares are provided as variadic arguments, the middlewares are applied left to right. If option.WithMiddleware is given multiple times, for example first in the client then the method, the middleware in the client will run first and the middleware given in the method will run next.

You may also replace the default http.Client with option.WithHTTPClient(client). Only one http client is accepted (this overwrites any previous client) and receives requests after any middleware has been applied.

Semantic versioning

This package generally follows SemVer conventions, though certain backwards-incompatible changes may be released as minor versions:

  1. Changes to library internals which are technically public but not intended or documented for external use. (Please open a GitHub issue to let us know if you are relying on such internals).
  2. Changes that we do not expect to impact the vast majority of users in practice.

We take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.

We are keen for your feedback; please open an issue with questions, bugs, or suggestions.

Contributing

See the contributing documentation.

Documentation

Index

Constants

View Source 
const HealthHealthHealthCodeFailed = shared.HealthHealthHealthCodeFailed

This is an alias to an internal value.

View Source 
const HealthHealthHealthCodeOk = shared.HealthHealthHealthCodeOk

This is an alias to an internal value.

View Source 
const HealthHealthHealthCodeUnderMaintenance = shared.HealthHealthHealthCodeUnderMaintenance

This is an alias to an internal value.

View Source 
const HealthHealthHealthCodeUnknown = shared.HealthHealthHealthCodeUnknown

This is an alias to an internal value.

View Source 
const HealthHealthHealthCodeWarning = shared.HealthHealthHealthCodeWarning

This is an alias to an internal value.

View Source 
const HealthRequestStatusStatusCodeBadGateway = shared.HealthRequestStatusStatusCodeBadGateway

This is an alias to an internal value.

View Source 
const HealthRequestStatusStatusCodeConflict = shared.HealthRequestStatusStatusCodeConflict

This is an alias to an internal value.

View Source 
const HealthRequestStatusStatusCodeExists = shared.HealthRequestStatusStatusCodeExists

This is an alias to an internal value.

View Source 
const HealthRequestStatusStatusCodeForbidden = shared.HealthRequestStatusStatusCodeForbidden

This is an alias to an internal value.

View Source 
const HealthRequestStatusStatusCodeInsufficientStorage = shared.HealthRequestStatusStatusCodeInsufficientStorage

This is an alias to an internal value.

View Source 
const HealthRequestStatusStatusCodeInternalError = shared.HealthRequestStatusStatusCodeInternalError

This is an alias to an internal value.

View Source 
const HealthRequestStatusStatusCodeInvalidRequest = shared.HealthRequestStatusStatusCodeInvalidRequest

This is an alias to an internal value.

View Source 
const HealthRequestStatusStatusCodeInvalidRequestData = shared.HealthRequestStatusStatusCodeInvalidRequestData

This is an alias to an internal value.

View Source 
const HealthRequestStatusStatusCodeInvalidRequestVersion = shared.HealthRequestStatusStatusCodeInvalidRequestVersion

This is an alias to an internal value.

View Source 
const HealthRequestStatusStatusCodeMethodNotAllowed = shared.HealthRequestStatusStatusCodeMethodNotAllowed

This is an alias to an internal value.

View Source 
const HealthRequestStatusStatusCodeNotAcceptable = shared.HealthRequestStatusStatusCodeNotAcceptable

This is an alias to an internal value.

View Source 
const HealthRequestStatusStatusCodeNotFound = shared.HealthRequestStatusStatusCodeNotFound

This is an alias to an internal value.

View Source 
const HealthRequestStatusStatusCodePayloadTooLarge = shared.HealthRequestStatusStatusCodePayloadTooLarge

This is an alias to an internal value.

View Source 
const HealthRequestStatusStatusCodePaymentRequired = shared.HealthRequestStatusStatusCodePaymentRequired

This is an alias to an internal value.

View Source 
const HealthRequestStatusStatusCodeServiceUnavailable = shared.HealthRequestStatusStatusCodeServiceUnavailable

This is an alias to an internal value.

View Source 
const HealthRequestStatusStatusCodeSuccess = shared.HealthRequestStatusStatusCodeSuccess

This is an alias to an internal value.

View Source 
const HealthRequestStatusStatusCodeTimeout = shared.HealthRequestStatusStatusCodeTimeout

This is an alias to an internal value.

View Source 
const HealthRequestStatusStatusCodeTooManyRequests = shared.HealthRequestStatusStatusCodeTooManyRequests

This is an alias to an internal value.

View Source 
const HealthRequestStatusStatusCodeUnauthorized = shared.HealthRequestStatusStatusCodeUnauthorized

This is an alias to an internal value.

View Source 
const HealthRequestStatusStatusCodeUnavailableForLegalReasons = shared.HealthRequestStatusStatusCodeUnavailableForLegalReasons

This is an alias to an internal value.

View Source 
const HealthRequestStatusStatusCodeUnknown = shared.HealthRequestStatusStatusCodeUnknown

This is an alias to an internal value.

View Source 
const HealthRequestStatusStatusCodeUnprocessableEntity = shared.HealthRequestStatusStatusCodeUnprocessableEntity

This is an alias to an internal value.

View Source 
const MeteringResultListRequestStatusStatusCodeBadGateway = shared.MeteringResultListRequestStatusStatusCodeBadGateway

This is an alias to an internal value.

View Source 
const MeteringResultListRequestStatusStatusCodeConflict = shared.MeteringResultListRequestStatusStatusCodeConflict

This is an alias to an internal value.

View Source 
const MeteringResultListRequestStatusStatusCodeExists = shared.MeteringResultListRequestStatusStatusCodeExists

This is an alias to an internal value.

View Source 
const MeteringResultListRequestStatusStatusCodeForbidden = shared.MeteringResultListRequestStatusStatusCodeForbidden

This is an alias to an internal value.

View Source 
const MeteringResultListRequestStatusStatusCodeInsufficientStorage = shared.MeteringResultListRequestStatusStatusCodeInsufficientStorage

This is an alias to an internal value.

View Source 
const MeteringResultListRequestStatusStatusCodeInternalError = shared.MeteringResultListRequestStatusStatusCodeInternalError

This is an alias to an internal value.

View Source 
const MeteringResultListRequestStatusStatusCodeInvalidRequest = shared.MeteringResultListRequestStatusStatusCodeInvalidRequest

This is an alias to an internal value.

View Source 
const MeteringResultListRequestStatusStatusCodeInvalidRequestData = shared.MeteringResultListRequestStatusStatusCodeInvalidRequestData

This is an alias to an internal value.

View Source 
const MeteringResultListRequestStatusStatusCodeInvalidRequestVersion = shared.MeteringResultListRequestStatusStatusCodeInvalidRequestVersion

This is an alias to an internal value.

View Source 
const MeteringResultListRequestStatusStatusCodeMethodNotAllowed = shared.MeteringResultListRequestStatusStatusCodeMethodNotAllowed

This is an alias to an internal value.

View Source 
const MeteringResultListRequestStatusStatusCodeNotAcceptable = shared.MeteringResultListRequestStatusStatusCodeNotAcceptable

This is an alias to an internal value.

View Source 
const MeteringResultListRequestStatusStatusCodeNotFound = shared.MeteringResultListRequestStatusStatusCodeNotFound

This is an alias to an internal value.

View Source 
const MeteringResultListRequestStatusStatusCodePayloadTooLarge = shared.MeteringResultListRequestStatusStatusCodePayloadTooLarge

This is an alias to an internal value.

View Source 
const MeteringResultListRequestStatusStatusCodePaymentRequired = shared.MeteringResultListRequestStatusStatusCodePaymentRequired

This is an alias to an internal value.

View Source 
const MeteringResultListRequestStatusStatusCodeServiceUnavailable = shared.MeteringResultListRequestStatusStatusCodeServiceUnavailable

This is an alias to an internal value.

View Source 
const MeteringResultListRequestStatusStatusCodeSuccess = shared.MeteringResultListRequestStatusStatusCodeSuccess

This is an alias to an internal value.

View Source 
const MeteringResultListRequestStatusStatusCodeTimeout = shared.MeteringResultListRequestStatusStatusCodeTimeout

This is an alias to an internal value.

View Source 
const MeteringResultListRequestStatusStatusCodeTooManyRequests = shared.MeteringResultListRequestStatusStatusCodeTooManyRequests

This is an alias to an internal value.

View Source 
const MeteringResultListRequestStatusStatusCodeUnauthorized = shared.MeteringResultListRequestStatusStatusCodeUnauthorized

This is an alias to an internal value.

View Source 
const MeteringResultListRequestStatusStatusCodeUnavailableForLegalReasons = shared.MeteringResultListRequestStatusStatusCodeUnavailableForLegalReasons

This is an alias to an internal value.

View Source 
const MeteringResultListRequestStatusStatusCodeUnknown = shared.MeteringResultListRequestStatusStatusCodeUnknown

This is an alias to an internal value.

View Source 
const MeteringResultListRequestStatusStatusCodeUnprocessableEntity = shared.MeteringResultListRequestStatusStatusCodeUnprocessableEntity

This is an alias to an internal value.

View Source 
const TeamListRequestStatusStatusCodeBadGateway = shared.TeamListRequestStatusStatusCodeBadGateway

This is an alias to an internal value.

View Source 
const TeamListRequestStatusStatusCodeConflict = shared.TeamListRequestStatusStatusCodeConflict

This is an alias to an internal value.

View Source 
const TeamListRequestStatusStatusCodeExists = shared.TeamListRequestStatusStatusCodeExists

This is an alias to an internal value.

View Source 
const TeamListRequestStatusStatusCodeForbidden = shared.TeamListRequestStatusStatusCodeForbidden

This is an alias to an internal value.

View Source 
const TeamListRequestStatusStatusCodeInsufficientStorage = shared.TeamListRequestStatusStatusCodeInsufficientStorage

This is an alias to an internal value.

View Source 
const TeamListRequestStatusStatusCodeInternalError = shared.TeamListRequestStatusStatusCodeInternalError

This is an alias to an internal value.

View Source 
const TeamListRequestStatusStatusCodeInvalidRequest = shared.TeamListRequestStatusStatusCodeInvalidRequest

This is an alias to an internal value.

View Source 
const TeamListRequestStatusStatusCodeInvalidRequestData = shared.TeamListRequestStatusStatusCodeInvalidRequestData

This is an alias to an internal value.

View Source 
const TeamListRequestStatusStatusCodeInvalidRequestVersion = shared.TeamListRequestStatusStatusCodeInvalidRequestVersion

This is an alias to an internal value.

View Source 
const TeamListRequestStatusStatusCodeMethodNotAllowed = shared.TeamListRequestStatusStatusCodeMethodNotAllowed

This is an alias to an internal value.

View Source 
const TeamListRequestStatusStatusCodeNotAcceptable = shared.TeamListRequestStatusStatusCodeNotAcceptable

This is an alias to an internal value.

View Source 
const TeamListRequestStatusStatusCodeNotFound = shared.TeamListRequestStatusStatusCodeNotFound

This is an alias to an internal value.

View Source 
const TeamListRequestStatusStatusCodePayloadTooLarge = shared.TeamListRequestStatusStatusCodePayloadTooLarge

This is an alias to an internal value.

View Source 
const TeamListRequestStatusStatusCodePaymentRequired = shared.TeamListRequestStatusStatusCodePaymentRequired

This is an alias to an internal value.

View Source 
const TeamListRequestStatusStatusCodeServiceUnavailable = shared.TeamListRequestStatusStatusCodeServiceUnavailable

This is an alias to an internal value.

View Source 
const TeamListRequestStatusStatusCodeSuccess = shared.TeamListRequestStatusStatusCodeSuccess

This is an alias to an internal value.

View Source 
const TeamListRequestStatusStatusCodeTimeout = shared.TeamListRequestStatusStatusCodeTimeout

This is an alias to an internal value.

View Source 
const TeamListRequestStatusStatusCodeTooManyRequests = shared.TeamListRequestStatusStatusCodeTooManyRequests

This is an alias to an internal value.

View Source 
const TeamListRequestStatusStatusCodeUnauthorized = shared.TeamListRequestStatusStatusCodeUnauthorized

This is an alias to an internal value.

View Source 
const TeamListRequestStatusStatusCodeUnavailableForLegalReasons = shared.TeamListRequestStatusStatusCodeUnavailableForLegalReasons

This is an alias to an internal value.

View Source 
const TeamListRequestStatusStatusCodeUnknown = shared.TeamListRequestStatusStatusCodeUnknown

This is an alias to an internal value.

View Source 
const TeamListRequestStatusStatusCodeUnprocessableEntity = shared.TeamListRequestStatusStatusCodeUnprocessableEntity

This is an alias to an internal value.

View Source 
const UserInvitationListInvitationsTypeOrganization = shared.UserInvitationListInvitationsTypeOrganization

This is an alias to an internal value.

View Source 
const UserInvitationListInvitationsTypeTeam = shared.UserInvitationListInvitationsTypeTeam

This is an alias to an internal value.

View Source 
const UserInvitationListRequestStatusStatusCodeBadGateway = shared.UserInvitationListRequestStatusStatusCodeBadGateway

This is an alias to an internal value.

View Source 
const UserInvitationListRequestStatusStatusCodeConflict = shared.UserInvitationListRequestStatusStatusCodeConflict

This is an alias to an internal value.

View Source 
const UserInvitationListRequestStatusStatusCodeExists = shared.UserInvitationListRequestStatusStatusCodeExists

This is an alias to an internal value.

View Source 
const UserInvitationListRequestStatusStatusCodeForbidden = shared.UserInvitationListRequestStatusStatusCodeForbidden

This is an alias to an internal value.

View Source 
const UserInvitationListRequestStatusStatusCodeInsufficientStorage = shared.UserInvitationListRequestStatusStatusCodeInsufficientStorage

This is an alias to an internal value.

View Source 
const UserInvitationListRequestStatusStatusCodeInternalError = shared.UserInvitationListRequestStatusStatusCodeInternalError

This is an alias to an internal value.

View Source 
const UserInvitationListRequestStatusStatusCodeInvalidRequest = shared.UserInvitationListRequestStatusStatusCodeInvalidRequest

This is an alias to an internal value.

View Source 
const UserInvitationListRequestStatusStatusCodeInvalidRequestData = shared.UserInvitationListRequestStatusStatusCodeInvalidRequestData

This is an alias to an internal value.

View Source 
const UserInvitationListRequestStatusStatusCodeInvalidRequestVersion = shared.UserInvitationListRequestStatusStatusCodeInvalidRequestVersion

This is an alias to an internal value.

View Source 
const UserInvitationListRequestStatusStatusCodeMethodNotAllowed = shared.UserInvitationListRequestStatusStatusCodeMethodNotAllowed

This is an alias to an internal value.

View Source 
const UserInvitationListRequestStatusStatusCodeNotAcceptable = shared.UserInvitationListRequestStatusStatusCodeNotAcceptable

This is an alias to an internal value.

View Source 
const UserInvitationListRequestStatusStatusCodeNotFound = shared.UserInvitationListRequestStatusStatusCodeNotFound

This is an alias to an internal value.

View Source 
const UserInvitationListRequestStatusStatusCodePayloadTooLarge = shared.UserInvitationListRequestStatusStatusCodePayloadTooLarge

This is an alias to an internal value.

View Source 
const UserInvitationListRequestStatusStatusCodePaymentRequired = shared.UserInvitationListRequestStatusStatusCodePaymentRequired

This is an alias to an internal value.

View Source 
const UserInvitationListRequestStatusStatusCodeServiceUnavailable = shared.UserInvitationListRequestStatusStatusCodeServiceUnavailable

This is an alias to an internal value.

View Source 
const UserInvitationListRequestStatusStatusCodeSuccess = shared.UserInvitationListRequestStatusStatusCodeSuccess

This is an alias to an internal value.

View Source 
const UserInvitationListRequestStatusStatusCodeTimeout = shared.UserInvitationListRequestStatusStatusCodeTimeout

This is an alias to an internal value.

View Source 
const UserInvitationListRequestStatusStatusCodeTooManyRequests = shared.UserInvitationListRequestStatusStatusCodeTooManyRequests

This is an alias to an internal value.

View Source 
const UserInvitationListRequestStatusStatusCodeUnauthorized = shared.UserInvitationListRequestStatusStatusCodeUnauthorized

This is an alias to an internal value.

View Source 
const UserInvitationListRequestStatusStatusCodeUnavailableForLegalReasons = shared.UserInvitationListRequestStatusStatusCodeUnavailableForLegalReasons

This is an alias to an internal value.

View Source 
const UserInvitationListRequestStatusStatusCodeUnknown = shared.UserInvitationListRequestStatusStatusCodeUnknown

This is an alias to an internal value.

View Source 
const UserInvitationListRequestStatusStatusCodeUnprocessableEntity = shared.UserInvitationListRequestStatusStatusCodeUnprocessableEntity

This is an alias to an internal value.

View Source 
const UserListRequestStatusStatusCodeBadGateway = shared.UserListRequestStatusStatusCodeBadGateway

This is an alias to an internal value.

View Source 
const UserListRequestStatusStatusCodeConflict = shared.UserListRequestStatusStatusCodeConflict

This is an alias to an internal value.

View Source 
const UserListRequestStatusStatusCodeExists = shared.UserListRequestStatusStatusCodeExists

This is an alias to an internal value.

View Source 
const UserListRequestStatusStatusCodeForbidden = shared.UserListRequestStatusStatusCodeForbidden

This is an alias to an internal value.

View Source 
const UserListRequestStatusStatusCodeInsufficientStorage = shared.UserListRequestStatusStatusCodeInsufficientStorage

This is an alias to an internal value.

View Source 
const UserListRequestStatusStatusCodeInternalError = shared.UserListRequestStatusStatusCodeInternalError

This is an alias to an internal value.

View Source 
const UserListRequestStatusStatusCodeInvalidRequest = shared.UserListRequestStatusStatusCodeInvalidRequest

This is an alias to an internal value.

View Source 
const UserListRequestStatusStatusCodeInvalidRequestData = shared.UserListRequestStatusStatusCodeInvalidRequestData

This is an alias to an internal value.

View Source 
const UserListRequestStatusStatusCodeInvalidRequestVersion = shared.UserListRequestStatusStatusCodeInvalidRequestVersion

This is an alias to an internal value.

View Source 
const UserListRequestStatusStatusCodeMethodNotAllowed = shared.UserListRequestStatusStatusCodeMethodNotAllowed

This is an alias to an internal value.

View Source 
const UserListRequestStatusStatusCodeNotAcceptable = shared.UserListRequestStatusStatusCodeNotAcceptable

This is an alias to an internal value.

View Source 
const UserListRequestStatusStatusCodeNotFound = shared.UserListRequestStatusStatusCodeNotFound

This is an alias to an internal value.

View Source 
const UserListRequestStatusStatusCodePayloadTooLarge = shared.UserListRequestStatusStatusCodePayloadTooLarge

This is an alias to an internal value.

View Source 
const UserListRequestStatusStatusCodePaymentRequired = shared.UserListRequestStatusStatusCodePaymentRequired

This is an alias to an internal value.

View Source 
const UserListRequestStatusStatusCodeServiceUnavailable = shared.UserListRequestStatusStatusCodeServiceUnavailable

This is an alias to an internal value.

View Source 
const UserListRequestStatusStatusCodeSuccess = shared.UserListRequestStatusStatusCodeSuccess

This is an alias to an internal value.

View Source 
const UserListRequestStatusStatusCodeTimeout = shared.UserListRequestStatusStatusCodeTimeout

This is an alias to an internal value.

View Source 
const UserListRequestStatusStatusCodeTooManyRequests = shared.UserListRequestStatusStatusCodeTooManyRequests

This is an alias to an internal value.

View Source 
const UserListRequestStatusStatusCodeUnauthorized = shared.UserListRequestStatusStatusCodeUnauthorized

This is an alias to an internal value.

View Source 
const UserListRequestStatusStatusCodeUnavailableForLegalReasons = shared.UserListRequestStatusStatusCodeUnavailableForLegalReasons

This is an alias to an internal value.

View Source 
const UserListRequestStatusStatusCodeUnknown = shared.UserListRequestStatusStatusCodeUnknown

This is an alias to an internal value.

View Source 
const UserListRequestStatusStatusCodeUnprocessableEntity = shared.UserListRequestStatusStatusCodeUnprocessableEntity

This is an alias to an internal value.

View Source 
const UserListUsersIdpTypeEnterprise = shared.UserListUsersIdpTypeEnterprise

This is an alias to an internal value.

View Source 
const UserListUsersIdpTypeNvidia = shared.UserListUsersIdpTypeNvidia

This is an alias to an internal value.

View Source 
const UserListUsersRolesOrgProductEnablementsTypeEmsCommercial = shared.UserListUsersRolesOrgProductEnablementsTypeEmsCommercial

This is an alias to an internal value.

View Source 
const UserListUsersRolesOrgProductEnablementsTypeEmsEval = shared.UserListUsersRolesOrgProductEnablementsTypeEmsEval

This is an alias to an internal value.

View Source 
const UserListUsersRolesOrgProductEnablementsTypeEmsNfr = shared.UserListUsersRolesOrgProductEnablementsTypeEmsNfr

This is an alias to an internal value.

View Source 
const UserListUsersRolesOrgProductEnablementsTypeNgcAdminCommercial = shared.UserListUsersRolesOrgProductEnablementsTypeNgcAdminCommercial

This is an alias to an internal value.

View Source 
const UserListUsersRolesOrgProductEnablementsTypeNgcAdminDeveloper = shared.UserListUsersRolesOrgProductEnablementsTypeNgcAdminDeveloper

This is an alias to an internal value.

View Source 
const UserListUsersRolesOrgProductEnablementsTypeNgcAdminEval = shared.UserListUsersRolesOrgProductEnablementsTypeNgcAdminEval

This is an alias to an internal value.

View Source 
const UserListUsersRolesOrgProductEnablementsTypeNgcAdminNfr = shared.UserListUsersRolesOrgProductEnablementsTypeNgcAdminNfr

This is an alias to an internal value.

View Source 
const UserListUsersRolesOrgProductSubscriptionsEmsEntitlementTypeEmsCommercial = shared.UserListUsersRolesOrgProductSubscriptionsEmsEntitlementTypeEmsCommercial

This is an alias to an internal value.

View Source 
const UserListUsersRolesOrgProductSubscriptionsEmsEntitlementTypeEmsCommerical = shared.UserListUsersRolesOrgProductSubscriptionsEmsEntitlementTypeEmsCommerical

This is an alias to an internal value.

View Source 
const UserListUsersRolesOrgProductSubscriptionsEmsEntitlementTypeEmsEval = shared.UserListUsersRolesOrgProductSubscriptionsEmsEntitlementTypeEmsEval

This is an alias to an internal value.

View Source 
const UserListUsersRolesOrgProductSubscriptionsEmsEntitlementTypeEmsNfr = shared.UserListUsersRolesOrgProductSubscriptionsEmsEntitlementTypeEmsNfr

This is an alias to an internal value.

View Source 
const UserListUsersRolesOrgProductSubscriptionsTypeNgcAdminCommercial = shared.UserListUsersRolesOrgProductSubscriptionsTypeNgcAdminCommercial

This is an alias to an internal value.

View Source 
const UserListUsersRolesOrgProductSubscriptionsTypeNgcAdminEval = shared.UserListUsersRolesOrgProductSubscriptionsTypeNgcAdminEval

This is an alias to an internal value.

View Source 
const UserListUsersRolesOrgProductSubscriptionsTypeNgcAdminNfr = shared.UserListUsersRolesOrgProductSubscriptionsTypeNgcAdminNfr

This is an alias to an internal value.

View Source 
const UserListUsersRolesOrgTypeCloud = shared.UserListUsersRolesOrgTypeCloud

This is an alias to an internal value.

View Source 
const UserListUsersRolesOrgTypeEnterprise = shared.UserListUsersRolesOrgTypeEnterprise

This is an alias to an internal value.

View Source 
const UserListUsersRolesOrgTypeIndividual = shared.UserListUsersRolesOrgTypeIndividual

This is an alias to an internal value.

View Source 
const UserListUsersRolesOrgTypeUnknown = shared.UserListUsersRolesOrgTypeUnknown

This is an alias to an internal value.

View Source 
const UserNcaRoleAdministrator = shared.UserNcaRoleAdministrator

This is an alias to an internal value.

View Source 
const UserNcaRoleMember = shared.UserNcaRoleMember

This is an alias to an internal value.

View Source 
const UserNcaRoleOwner = shared.UserNcaRoleOwner

This is an alias to an internal value.

View Source 
const UserNcaRolePending = shared.UserNcaRolePending

This is an alias to an internal value.

View Source 
const UserNcaRoleUnknown = shared.UserNcaRoleUnknown

This is an alias to an internal value.

View Source 
const UserRequestStatusStatusCodeBadGateway = shared.UserRequestStatusStatusCodeBadGateway

This is an alias to an internal value.

View Source 
const UserRequestStatusStatusCodeConflict = shared.UserRequestStatusStatusCodeConflict

This is an alias to an internal value.

View Source 
const UserRequestStatusStatusCodeExists = shared.UserRequestStatusStatusCodeExists

This is an alias to an internal value.

View Source 
const UserRequestStatusStatusCodeForbidden = shared.UserRequestStatusStatusCodeForbidden

This is an alias to an internal value.

View Source 
const UserRequestStatusStatusCodeInsufficientStorage = shared.UserRequestStatusStatusCodeInsufficientStorage

This is an alias to an internal value.

View Source 
const UserRequestStatusStatusCodeInternalError = shared.UserRequestStatusStatusCodeInternalError

This is an alias to an internal value.

View Source 
const UserRequestStatusStatusCodeInvalidRequest = shared.UserRequestStatusStatusCodeInvalidRequest

This is an alias to an internal value.

View Source 
const UserRequestStatusStatusCodeInvalidRequestData = shared.UserRequestStatusStatusCodeInvalidRequestData

This is an alias to an internal value.

View Source 
const UserRequestStatusStatusCodeInvalidRequestVersion = shared.UserRequestStatusStatusCodeInvalidRequestVersion

This is an alias to an internal value.

View Source 
const UserRequestStatusStatusCodeMethodNotAllowed = shared.UserRequestStatusStatusCodeMethodNotAllowed

This is an alias to an internal value.

View Source 
const UserRequestStatusStatusCodeNotAcceptable = shared.UserRequestStatusStatusCodeNotAcceptable

This is an alias to an internal value.

View Source 
const UserRequestStatusStatusCodeNotFound = shared.UserRequestStatusStatusCodeNotFound

This is an alias to an internal value.

View Source 
const UserRequestStatusStatusCodePayloadTooLarge = shared.UserRequestStatusStatusCodePayloadTooLarge

This is an alias to an internal value.

View Source 
const UserRequestStatusStatusCodePaymentRequired = shared.UserRequestStatusStatusCodePaymentRequired

This is an alias to an internal value.

View Source 
const UserRequestStatusStatusCodeServiceUnavailable = shared.UserRequestStatusStatusCodeServiceUnavailable

This is an alias to an internal value.

View Source 
const UserRequestStatusStatusCodeSuccess = shared.UserRequestStatusStatusCodeSuccess

This is an alias to an internal value.

View Source 
const UserRequestStatusStatusCodeTimeout = shared.UserRequestStatusStatusCodeTimeout

This is an alias to an internal value.

View Source 
const UserRequestStatusStatusCodeTooManyRequests = shared.UserRequestStatusStatusCodeTooManyRequests

This is an alias to an internal value.

View Source 
const UserRequestStatusStatusCodeUnauthorized = shared.UserRequestStatusStatusCodeUnauthorized

This is an alias to an internal value.

View Source 
const UserRequestStatusStatusCodeUnavailableForLegalReasons = shared.UserRequestStatusStatusCodeUnavailableForLegalReasons

This is an alias to an internal value.

View Source 
const UserRequestStatusStatusCodeUnknown = shared.UserRequestStatusStatusCodeUnknown

This is an alias to an internal value.

View Source 
const UserRequestStatusStatusCodeUnprocessableEntity = shared.UserRequestStatusStatusCodeUnprocessableEntity

This is an alias to an internal value.

View Source 
const UserUserIdpTypeEnterprise = shared.UserUserIdpTypeEnterprise

This is an alias to an internal value.

View Source 
const UserUserIdpTypeNvidia = shared.UserUserIdpTypeNvidia

This is an alias to an internal value.

View Source 
const UserUserRolesOrgProductEnablementsTypeEmsCommercial = shared.UserUserRolesOrgProductEnablementsTypeEmsCommercial

This is an alias to an internal value.

View Source 
const UserUserRolesOrgProductEnablementsTypeEmsEval = shared.UserUserRolesOrgProductEnablementsTypeEmsEval

This is an alias to an internal value.

View Source 
const UserUserRolesOrgProductEnablementsTypeEmsNfr = shared.UserUserRolesOrgProductEnablementsTypeEmsNfr

This is an alias to an internal value.

View Source 
const UserUserRolesOrgProductEnablementsTypeNgcAdminCommercial = shared.UserUserRolesOrgProductEnablementsTypeNgcAdminCommercial

This is an alias to an internal value.

View Source 
const UserUserRolesOrgProductEnablementsTypeNgcAdminDeveloper = shared.UserUserRolesOrgProductEnablementsTypeNgcAdminDeveloper

This is an alias to an internal value.

View Source 
const UserUserRolesOrgProductEnablementsTypeNgcAdminEval = shared.UserUserRolesOrgProductEnablementsTypeNgcAdminEval

This is an alias to an internal value.

View Source 
const UserUserRolesOrgProductEnablementsTypeNgcAdminNfr = shared.UserUserRolesOrgProductEnablementsTypeNgcAdminNfr

This is an alias to an internal value.

View Source 
const UserUserRolesOrgProductSubscriptionsEmsEntitlementTypeEmsCommercial = shared.UserUserRolesOrgProductSubscriptionsEmsEntitlementTypeEmsCommercial

This is an alias to an internal value.

View Source 
const UserUserRolesOrgProductSubscriptionsEmsEntitlementTypeEmsCommerical = shared.UserUserRolesOrgProductSubscriptionsEmsEntitlementTypeEmsCommerical

This is an alias to an internal value.

View Source 
const UserUserRolesOrgProductSubscriptionsEmsEntitlementTypeEmsEval = shared.UserUserRolesOrgProductSubscriptionsEmsEntitlementTypeEmsEval

This is an alias to an internal value.

View Source 
const UserUserRolesOrgProductSubscriptionsEmsEntitlementTypeEmsNfr = shared.UserUserRolesOrgProductSubscriptionsEmsEntitlementTypeEmsNfr

This is an alias to an internal value.

View Source 
const UserUserRolesOrgProductSubscriptionsTypeNgcAdminCommercial = shared.UserUserRolesOrgProductSubscriptionsTypeNgcAdminCommercial

This is an alias to an internal value.

View Source 
const UserUserRolesOrgProductSubscriptionsTypeNgcAdminEval = shared.UserUserRolesOrgProductSubscriptionsTypeNgcAdminEval

This is an alias to an internal value.

View Source 
const UserUserRolesOrgProductSubscriptionsTypeNgcAdminNfr = shared.UserUserRolesOrgProductSubscriptionsTypeNgcAdminNfr

This is an alias to an internal value.

View Source 
const UserUserRolesOrgTypeCloud = shared.UserUserRolesOrgTypeCloud

This is an alias to an internal value.

View Source 
const UserUserRolesOrgTypeEnterprise = shared.UserUserRolesOrgTypeEnterprise

This is an alias to an internal value.

View Source 
const UserUserRolesOrgTypeIndividual = shared.UserUserRolesOrgTypeIndividual

This is an alias to an internal value.

View Source 
const UserUserRolesOrgTypeUnknown = shared.UserUserRolesOrgTypeUnknown

This is an alias to an internal value.

Variables

This section is empty.

Functions

func Bool 

func Bool(value bool) param.Field[bool]

Bool is a param field helper which helps specify bools.

func F 

func F[T any](value T) param.Field[T]

F is a param field helper used to initialize a param.Field generic struct. This helps specify null, zero values, and overrides, as well as normal values. You can read more about this in our README.

func FileParam 

func FileParam(reader io.Reader, filename string, contentType string) param.Field[io.Reader]

FileParam is a param field helper which helps files with a mime content-type.

func Float 

func Float(value float64) param.Field[float64]

Float is a param field helper which helps specify floats.

func Int 

func Int(value int64) param.Field[int64]

Int is a param field helper which helps specify integers. This is particularly helpful when specifying integer constants for fields.

func Null 

func Null[T any]() param.Field[T]

Null is a param field helper which explicitly sends null to the API.

func Raw 

func Raw[T any](value any) param.Field[T]

Raw is a param field helper for specifying values for fields when the type you are looking to send is different from the type that is specified in the SDK. For example, if the type of the field is an integer, but you want to send a float, you could do that by setting the corresponding field with Raw[int](0.5).

func String 

func String(value string) param.Field[string]

String is a param field helper which helps specify strings.

Types

type AdminOrgListParams 

type AdminOrgListParams struct {
	FilterUsingOrgDisplayName param.Field[string]                                     `query:"Filter using org display name"`
	FilterUsingOrgOwnerEmail  param.Field[AdminOrgListParamsFilterUsingOrgOwnerEmail] `query:"Filter using org owner email"`
	FilterUsingOrgOwnerName   param.Field[string]                                     `query:"Filter using org owner name"`
	// Org description to search
	OrgDesc param.Field[string] `query:"org-desc"`
	// Org name to search
	OrgName param.Field[string] `query:"org-name"`
	// Org Type to search
	OrgType param.Field[AdminOrgListParamsOrgType] `query:"org-type"`
	// The page number of result
	PageNumber param.Field[int64] `query:"page-number"`
	// The page size of result
	PageSize param.Field[int64] `query:"page-size"`
	// PEC ID to search
	PecID param.Field[string] `query:"pec-id"`
}

func (AdminOrgListParams) URLQuery 

func (r AdminOrgListParams) URLQuery() (v url.Values)

URLQuery serializes AdminOrgListParams's query parameters as `url.Values`.

type AdminOrgListParamsFilterUsingOrgOwnerEmail 

type AdminOrgListParamsFilterUsingOrgOwnerEmail struct {
	EmailShouldBeBase64Encoded param.Field[string] `query:" Email should be base-64-encoded"`
}

func (AdminOrgListParamsFilterUsingOrgOwnerEmail) URLQuery 

func (r AdminOrgListParamsFilterUsingOrgOwnerEmail) URLQuery() (v url.Values)

URLQuery serializes AdminOrgListParamsFilterUsingOrgOwnerEmail's query parameters as `url.Values`.

type AdminOrgListParamsOrgType 

type AdminOrgListParamsOrgType string

Org Type to search 

const (
	AdminOrgListParamsOrgTypeUnknown    AdminOrgListParamsOrgType = "UNKNOWN"
	AdminOrgListParamsOrgTypeCloud      AdminOrgListParamsOrgType = "CLOUD"
	AdminOrgListParamsOrgTypeEnterprise AdminOrgListParamsOrgType = "ENTERPRISE"
	AdminOrgListParamsOrgTypeIndividual AdminOrgListParamsOrgType = "INDIVIDUAL"
)

func (AdminOrgListParamsOrgType) IsKnown 

func (r AdminOrgListParamsOrgType) IsKnown() bool

type AdminOrgListResponse 

type AdminOrgListResponse struct {
	// Unique Id of this team.
	ID int64 `json:"id"`
	// Org Owner Alternate Contact
	AlternateContact AdminOrgListResponseAlternateContact `json:"alternateContact"`
	// Billing account ID.
	BillingAccountID string `json:"billingAccountId"`
	// Identifies if the org can be reused.
	CanAddOn bool `json:"canAddOn"`
	// ISO country code of the organization.
	Country string `json:"country"`
	// Optional description of the organization.
	Description string `json:"description"`
	// Name of the organization that will be shown to users.
	DisplayName string `json:"displayName"`
	// Identity Provider ID.
	IdpID string `json:"idpId"`
	// Industry of the organization.
	Industry string `json:"industry"`
	// Infinity manager setting definition
	InfinityManagerSettings AdminOrgListResponseInfinityManagerSettings `json:"infinityManagerSettings"`
	// Dataset Service enable flag for an organization
	IsDatasetServiceEnabled bool `json:"isDatasetServiceEnabled"`
	// Is NVIDIA internal org or not
	IsInternal bool `json:"isInternal"`
	// Indicates when the org is a proto org
	IsProto bool `json:"isProto"`
	// Quick Start enable flag for an organization
	IsQuickStartEnabled bool `json:"isQuickStartEnabled"`
	// If a server side encryption is enabled for private registry (models, resources)
	IsRegistrySseEnabled bool `json:"isRegistrySSEEnabled"`
	// Secrets Manager Service enable flag for an organization
	IsSecretsManagerServiceEnabled bool `json:"isSecretsManagerServiceEnabled"`
	// Secure Credential Sharing Service enable flag for an organization
	IsSecureCredentialSharingServiceEnabled bool `json:"isSecureCredentialSharingServiceEnabled"`
	// If a separate influx db used for an organization in BCP for job telemetry
	IsSeparateInfluxDBUsed bool `json:"isSeparateInfluxDbUsed"`
	// Organization name.
	Name string `json:"name"`
	// NVIDIA Cloud Account Number.
	Nan string `json:"nan"`
	// Org owner.
	OrgOwner AdminOrgListResponseOrgOwner `json:"orgOwner"`
	// Org owners
	OrgOwners []AdminOrgListResponseOrgOwner `json:"orgOwners"`
	// Product end customer salesforce.com Id (external customer Id). pecSfdcId is for
	// EMS (entitlement management service) to track external paid customer.
	PecSfdcID            string                                    `json:"pecSfdcId"`
	ProductEnablements   []AdminOrgListResponseProductEnablement   `json:"productEnablements"`
	ProductSubscriptions []AdminOrgListResponseProductSubscription `json:"productSubscriptions"`
	// Repo scan setting definition
	RepoScanSettings AdminOrgListResponseRepoScanSettings `json:"repoScanSettings"`
	Type             AdminOrgListResponseType             `json:"type"`
	// Users information.
	UsersInfo AdminOrgListResponseUsersInfo `json:"usersInfo"`
	JSON      adminOrgListResponseJSON      `json:"-"`
}

Information about the Organization

func (*AdminOrgListResponse) UnmarshalJSON 

func (r *AdminOrgListResponse) UnmarshalJSON(data []byte) (err error)

type AdminOrgListResponseAlternateContact 

type AdminOrgListResponseAlternateContact struct {
	// Alternate contact's email.
	Email string `json:"email"`
	// Full name of the alternate contact.
	FullName string                                   `json:"fullName"`
	JSON     adminOrgListResponseAlternateContactJSON `json:"-"`
}

Org Owner Alternate Contact

func (*AdminOrgListResponseAlternateContact) UnmarshalJSON 

func (r *AdminOrgListResponseAlternateContact) UnmarshalJSON(data []byte) (err error)

type AdminOrgListResponseInfinityManagerSettings 

type AdminOrgListResponseInfinityManagerSettings struct {
	// Enable the infinity manager or not. Used both in org and team level object
	InfinityManagerEnabled bool `json:"infinityManagerEnabled"`
	// Allow override settings at team level. Only used in org level object
	InfinityManagerEnableTeamOverride bool                                            `json:"infinityManagerEnableTeamOverride"`
	JSON                              adminOrgListResponseInfinityManagerSettingsJSON `json:"-"`
}

Infinity manager setting definition

func (*AdminOrgListResponseInfinityManagerSettings) UnmarshalJSON 

func (r *AdminOrgListResponseInfinityManagerSettings) UnmarshalJSON(data []byte) (err error)

type AdminOrgListResponseOrgOwner 

type AdminOrgListResponseOrgOwner struct {
	// Email address of the org owner.
	Email string `json:"email,required"`
	// Org owner name.
	FullName string `json:"fullName,required"`
	// Last time the org owner logged in.
	LastLoginDate string                           `json:"lastLoginDate"`
	JSON          adminOrgListResponseOrgOwnerJSON `json:"-"`
}

Org owner.

func (*AdminOrgListResponseOrgOwner) UnmarshalJSON 

func (r *AdminOrgListResponseOrgOwner) UnmarshalJSON(data []byte) (err error)

type AdminOrgListResponseProductEnablement 

type AdminOrgListResponseProductEnablement struct {
	// Product Name (NVAIE, BASE_COMMAND, REGISTRY, etc)
	ProductName string `json:"productName,required"`
	// Product Enablement Types
	Type AdminOrgListResponseProductEnablementsType `json:"type,required"`
	// Date on which the subscription expires. The subscription is invalid after this
	// date. (yyyy-MM-dd)
	ExpirationDate string                                           `json:"expirationDate"`
	PoDetails      []AdminOrgListResponseProductEnablementsPoDetail `json:"poDetails"`
	JSON           adminOrgListResponseProductEnablementJSON        `json:"-"`
}

Product Enablement

func (*AdminOrgListResponseProductEnablement) UnmarshalJSON 

func (r *AdminOrgListResponseProductEnablement) UnmarshalJSON(data []byte) (err error)

type AdminOrgListResponseProductEnablementsPoDetail 

type AdminOrgListResponseProductEnablementsPoDetail struct {
	// Entitlement identifier.
	EntitlementID string `json:"entitlementId"`
	// PAK (Product Activation Key) identifier.
	PkID string                                             `json:"pkId"`
	JSON adminOrgListResponseProductEnablementsPoDetailJSON `json:"-"`
}

Purchase Order.

func (*AdminOrgListResponseProductEnablementsPoDetail) UnmarshalJSON 

func (r *AdminOrgListResponseProductEnablementsPoDetail) UnmarshalJSON(data []byte) (err error)

type AdminOrgListResponseProductEnablementsType 

type AdminOrgListResponseProductEnablementsType string

Product Enablement Types 

const (
	AdminOrgListResponseProductEnablementsTypeNgcAdminEval       AdminOrgListResponseProductEnablementsType = "NGC_ADMIN_EVAL"
	AdminOrgListResponseProductEnablementsTypeNgcAdminNfr        AdminOrgListResponseProductEnablementsType = "NGC_ADMIN_NFR"
	AdminOrgListResponseProductEnablementsTypeNgcAdminCommercial AdminOrgListResponseProductEnablementsType = "NGC_ADMIN_COMMERCIAL"
	AdminOrgListResponseProductEnablementsTypeEmsEval            AdminOrgListResponseProductEnablementsType = "EMS_EVAL"
	AdminOrgListResponseProductEnablementsTypeEmsNfr             AdminOrgListResponseProductEnablementsType = "EMS_NFR"
	AdminOrgListResponseProductEnablementsTypeEmsCommercial      AdminOrgListResponseProductEnablementsType = "EMS_COMMERCIAL"
	AdminOrgListResponseProductEnablementsTypeNgcAdminDeveloper  AdminOrgListResponseProductEnablementsType = "NGC_ADMIN_DEVELOPER"
)

func (AdminOrgListResponseProductEnablementsType) IsKnown 

func (r AdminOrgListResponseProductEnablementsType) IsKnown() bool

type AdminOrgListResponseProductSubscription 

type AdminOrgListResponseProductSubscription struct {
	// Product Name (NVAIE, BASE_COMMAND, FleetCommand, REGISTRY, etc).
	ProductName string `json:"productName,required"`
	// Unique entitlement identifier
	ID string `json:"id"`
	// EMS Subscription type. (options: EMS_EVAL, EMS_NFR and EMS_COMMERCIAL)
	EmsEntitlementType AdminOrgListResponseProductSubscriptionsEmsEntitlementType `json:"emsEntitlementType"`
	// Date on which the subscription expires. The subscription is invalid after this
	// date. (yyyy-MM-dd)
	ExpirationDate string `json:"expirationDate"`
	// Date on which the subscription becomes active. (yyyy-MM-dd)
	StartDate string `json:"startDate"`
	// Subscription type. (options: NGC_ADMIN_EVAL, NGC_ADMIN_NFR,
	// NGC_ADMIN_COMMERCIAL)
	Type AdminOrgListResponseProductSubscriptionsType `json:"type"`
	JSON adminOrgListResponseProductSubscriptionJSON  `json:"-"`
}

Product Subscription

func (*AdminOrgListResponseProductSubscription) UnmarshalJSON 

func (r *AdminOrgListResponseProductSubscription) UnmarshalJSON(data []byte) (err error)

type AdminOrgListResponseProductSubscriptionsEmsEntitlementType 

type AdminOrgListResponseProductSubscriptionsEmsEntitlementType string

EMS Subscription type. (options: EMS_EVAL, EMS_NFR and EMS_COMMERCIAL) 

const (
	AdminOrgListResponseProductSubscriptionsEmsEntitlementTypeEmsEval       AdminOrgListResponseProductSubscriptionsEmsEntitlementType = "EMS_EVAL"
	AdminOrgListResponseProductSubscriptionsEmsEntitlementTypeEmsNfr        AdminOrgListResponseProductSubscriptionsEmsEntitlementType = "EMS_NFR"
	AdminOrgListResponseProductSubscriptionsEmsEntitlementTypeEmsCommerical AdminOrgListResponseProductSubscriptionsEmsEntitlementType = "EMS_COMMERICAL"
	AdminOrgListResponseProductSubscriptionsEmsEntitlementTypeEmsCommercial AdminOrgListResponseProductSubscriptionsEmsEntitlementType = "EMS_COMMERCIAL"
)

func (AdminOrgListResponseProductSubscriptionsEmsEntitlementType) IsKnown 

func (r AdminOrgListResponseProductSubscriptionsEmsEntitlementType) IsKnown() bool

type AdminOrgListResponseProductSubscriptionsType 

type AdminOrgListResponseProductSubscriptionsType string

Subscription type. (options: NGC_ADMIN_EVAL, NGC_ADMIN_NFR, NGC_ADMIN_COMMERCIAL) 

const (
	AdminOrgListResponseProductSubscriptionsTypeNgcAdminEval       AdminOrgListResponseProductSubscriptionsType = "NGC_ADMIN_EVAL"
	AdminOrgListResponseProductSubscriptionsTypeNgcAdminNfr        AdminOrgListResponseProductSubscriptionsType = "NGC_ADMIN_NFR"
	AdminOrgListResponseProductSubscriptionsTypeNgcAdminCommercial AdminOrgListResponseProductSubscriptionsType = "NGC_ADMIN_COMMERCIAL"
)

func (AdminOrgListResponseProductSubscriptionsType) IsKnown 

func (r AdminOrgListResponseProductSubscriptionsType) IsKnown() bool

type AdminOrgListResponseRepoScanSettings 

type AdminOrgListResponseRepoScanSettings struct {
	// Allow org admin to override the org level repo scan settings
	RepoScanAllowOverride bool `json:"repoScanAllowOverride"`
	// Allow repository scanning by default
	RepoScanByDefault bool `json:"repoScanByDefault"`
	// Enable the repository scan or not. Only used in org level object
	RepoScanEnabled bool `json:"repoScanEnabled"`
	// Sends notification to end user after scanning is done
	RepoScanEnableNotifications bool `json:"repoScanEnableNotifications"`
	// Allow override settings at team level. Only used in org level object
	RepoScanEnableTeamOverride bool `json:"repoScanEnableTeamOverride"`
	// Allow showing scan results to CLI or UI
	RepoScanShowResults bool                                     `json:"repoScanShowResults"`
	JSON                adminOrgListResponseRepoScanSettingsJSON `json:"-"`
}

Repo scan setting definition

func (*AdminOrgListResponseRepoScanSettings) UnmarshalJSON 

func (r *AdminOrgListResponseRepoScanSettings) UnmarshalJSON(data []byte) (err error)

type AdminOrgListResponseType 

type AdminOrgListResponseType string
const (
	AdminOrgListResponseTypeUnknown    AdminOrgListResponseType = "UNKNOWN"
	AdminOrgListResponseTypeCloud      AdminOrgListResponseType = "CLOUD"
	AdminOrgListResponseTypeEnterprise AdminOrgListResponseType = "ENTERPRISE"
	AdminOrgListResponseTypeIndividual AdminOrgListResponseType = "INDIVIDUAL"
)

func (AdminOrgListResponseType) IsKnown 

func (r AdminOrgListResponseType) IsKnown() bool

type AdminOrgListResponseUsersInfo 

type AdminOrgListResponseUsersInfo struct {
	// Total number of users.
	TotalUsers int64                             `json:"totalUsers"`
	JSON       adminOrgListResponseUsersInfoJSON `json:"-"`
}

Users information.

func (*AdminOrgListResponseUsersInfo) UnmarshalJSON 

func (r *AdminOrgListResponseUsersInfo) UnmarshalJSON(data []byte) (err error)

type AdminOrgNcaIDNewParams 

type AdminOrgNcaIDNewParams struct {
	// List of nca Ids
	NcaIDs param.Field[[]string] `json:"ncaIds"`
	// List of org names
	OrgNames param.Field[[]string] `json:"orgNames"`
}

func (AdminOrgNcaIDNewParams) MarshalJSON 

func (r AdminOrgNcaIDNewParams) MarshalJSON() (data []byte, err error)

type AdminOrgNcaIDService 

type AdminOrgNcaIDService struct {
	Options []option.RequestOption
}

AdminOrgNcaIDService contains methods and other services that help with interacting with the ngc API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewAdminOrgNcaIDService method instead.

func NewAdminOrgNcaIDService 

func NewAdminOrgNcaIDService(opts ...option.RequestOption) (r *AdminOrgNcaIDService)

NewAdminOrgNcaIDService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*AdminOrgNcaIDService) New 

func (r *AdminOrgNcaIDService) New(ctx context.Context, body AdminOrgNcaIDNewParams, opts ...option.RequestOption) (res *http.Response, err error)

Get Organization by NCA ID or Org Name. (SuperAdmin privileges required)

type AdminOrgNewParams 

type AdminOrgNewParams struct {
	// user country
	Country param.Field[string] `json:"country"`
	// optional description of the organization
	Description param.Field[string] `json:"description"`
	// Name of the organization that will be shown to users.
	DisplayName param.Field[string] `json:"displayName"`
	// Identify the initiator of the org request
	Initiator param.Field[string] `json:"initiator"`
	// Is NVIDIA internal org or not
	IsInternal param.Field[bool] `json:"isInternal"`
	// Organization name
	Name param.Field[string] `json:"name"`
	// NVIDIA Cloud Account Identifier
	NcaID param.Field[string] `json:"ncaId"`
	// NVIDIA Cloud Account Number
	NcaNumber param.Field[string] `json:"ncaNumber"`
	// Org owner.
	OrgOwner param.Field[AdminOrgNewParamsOrgOwner] `json:"orgOwner"`
	// product end customer name for enterprise(Fleet Command) product
	PecName param.Field[string] `json:"pecName"`
	// product end customer salesforce.com Id (external customer Id) for
	// enterprise(Fleet Command) product
	PecSfdcID          param.Field[string]                               `json:"pecSfdcId"`
	ProductEnablements param.Field[[]AdminOrgNewParamsProductEnablement] `json:"productEnablements"`
	// This should be deprecated, use productEnablements instead
	ProductSubscriptions param.Field[[]AdminOrgNewParamsProductSubscription] `json:"productSubscriptions"`
	// Proto org identifier
	ProtoOrgID param.Field[string] `json:"protoOrgId"`
	// Company or organization industry
	SalesforceAccountIndustry param.Field[string] `json:"salesforceAccountIndustry"`
	// Send email to org owner or not. Default is true
	SendEmail param.Field[bool]                  `json:"sendEmail"`
	Type      param.Field[AdminOrgNewParamsType] `json:"type"`
	Ncid      param.Field[string]                `cookie:"ncid"`
	VisitorID param.Field[string]                `cookie:"VisitorID"`
}

func (AdminOrgNewParams) MarshalJSON 

func (r AdminOrgNewParams) MarshalJSON() (data []byte, err error)

type AdminOrgNewParamsOrgOwner 

type AdminOrgNewParamsOrgOwner struct {
	// Email address of the org owner.
	Email param.Field[string] `json:"email,required"`
	// Org owner name.
	FullName param.Field[string] `json:"fullName"`
	// Identity Provider ID of the org owner.
	IdpID param.Field[string] `json:"idpId"`
	// Starfleet ID of the org owner.
	StarfleetID param.Field[string] `json:"starfleetId"`
}

Org owner.

func (AdminOrgNewParamsOrgOwner) MarshalJSON 

func (r AdminOrgNewParamsOrgOwner) MarshalJSON() (data []byte, err error)

type AdminOrgNewParamsProductEnablement 

type AdminOrgNewParamsProductEnablement struct {
	// Product Name (NVAIE, BASE_COMMAND, REGISTRY, etc)
	ProductName param.Field[string] `json:"productName,required"`
	// Product Enablement Types
	Type param.Field[AdminOrgNewParamsProductEnablementsType] `json:"type,required"`
	// Date on which the subscription expires. The subscription is invalid after this
	// date. (yyyy-MM-dd)
	ExpirationDate param.Field[string]                                        `json:"expirationDate"`
	PoDetails      param.Field[[]AdminOrgNewParamsProductEnablementsPoDetail] `json:"poDetails"`
}

Product Enablement

func (AdminOrgNewParamsProductEnablement) MarshalJSON 

func (r AdminOrgNewParamsProductEnablement) MarshalJSON() (data []byte, err error)

type AdminOrgNewParamsProductEnablementsPoDetail 

type AdminOrgNewParamsProductEnablementsPoDetail struct {
	// Entitlement identifier.
	EntitlementID param.Field[string] `json:"entitlementId"`
	// PAK (Product Activation Key) identifier.
	PkID param.Field[string] `json:"pkId"`
}

Purchase Order.

func (AdminOrgNewParamsProductEnablementsPoDetail) MarshalJSON 

func (r AdminOrgNewParamsProductEnablementsPoDetail) MarshalJSON() (data []byte, err error)

type AdminOrgNewParamsProductEnablementsType 

type AdminOrgNewParamsProductEnablementsType string

Product Enablement Types 

const (
	AdminOrgNewParamsProductEnablementsTypeNgcAdminEval       AdminOrgNewParamsProductEnablementsType = "NGC_ADMIN_EVAL"
	AdminOrgNewParamsProductEnablementsTypeNgcAdminNfr        AdminOrgNewParamsProductEnablementsType = "NGC_ADMIN_NFR"
	AdminOrgNewParamsProductEnablementsTypeNgcAdminCommercial AdminOrgNewParamsProductEnablementsType = "NGC_ADMIN_COMMERCIAL"
	AdminOrgNewParamsProductEnablementsTypeEmsEval            AdminOrgNewParamsProductEnablementsType = "EMS_EVAL"
	AdminOrgNewParamsProductEnablementsTypeEmsNfr             AdminOrgNewParamsProductEnablementsType = "EMS_NFR"
	AdminOrgNewParamsProductEnablementsTypeEmsCommercial      AdminOrgNewParamsProductEnablementsType = "EMS_COMMERCIAL"
	AdminOrgNewParamsProductEnablementsTypeNgcAdminDeveloper  AdminOrgNewParamsProductEnablementsType = "NGC_ADMIN_DEVELOPER"
)

func (AdminOrgNewParamsProductEnablementsType) IsKnown 

func (r AdminOrgNewParamsProductEnablementsType) IsKnown() bool

type AdminOrgNewParamsProductSubscription 

type AdminOrgNewParamsProductSubscription struct {
	// Product Name (NVAIE, BASE_COMMAND, FleetCommand, REGISTRY, etc).
	ProductName param.Field[string] `json:"productName,required"`
	// Unique entitlement identifier
	ID param.Field[string] `json:"id"`
	// EMS Subscription type. (options: EMS_EVAL, EMS_NFR and EMS_COMMERCIAL)
	EmsEntitlementType param.Field[AdminOrgNewParamsProductSubscriptionsEmsEntitlementType] `json:"emsEntitlementType"`
	// Date on which the subscription expires. The subscription is invalid after this
	// date. (yyyy-MM-dd)
	ExpirationDate param.Field[string] `json:"expirationDate"`
	// Date on which the subscription becomes active. (yyyy-MM-dd)
	StartDate param.Field[string] `json:"startDate"`
	// Subscription type. (options: NGC_ADMIN_EVAL, NGC_ADMIN_NFR,
	// NGC_ADMIN_COMMERCIAL)
	Type param.Field[AdminOrgNewParamsProductSubscriptionsType] `json:"type"`
}

Product Subscription

func (AdminOrgNewParamsProductSubscription) MarshalJSON 

func (r AdminOrgNewParamsProductSubscription) MarshalJSON() (data []byte, err error)

type AdminOrgNewParamsProductSubscriptionsEmsEntitlementType 

type AdminOrgNewParamsProductSubscriptionsEmsEntitlementType string

EMS Subscription type. (options: EMS_EVAL, EMS_NFR and EMS_COMMERCIAL) 

const (
	AdminOrgNewParamsProductSubscriptionsEmsEntitlementTypeEmsEval       AdminOrgNewParamsProductSubscriptionsEmsEntitlementType = "EMS_EVAL"
	AdminOrgNewParamsProductSubscriptionsEmsEntitlementTypeEmsNfr        AdminOrgNewParamsProductSubscriptionsEmsEntitlementType = "EMS_NFR"
	AdminOrgNewParamsProductSubscriptionsEmsEntitlementTypeEmsCommerical AdminOrgNewParamsProductSubscriptionsEmsEntitlementType = "EMS_COMMERICAL"
	AdminOrgNewParamsProductSubscriptionsEmsEntitlementTypeEmsCommercial AdminOrgNewParamsProductSubscriptionsEmsEntitlementType = "EMS_COMMERCIAL"
)

func (AdminOrgNewParamsProductSubscriptionsEmsEntitlementType) IsKnown 

func (r AdminOrgNewParamsProductSubscriptionsEmsEntitlementType) IsKnown() bool

type AdminOrgNewParamsProductSubscriptionsType 

type AdminOrgNewParamsProductSubscriptionsType string

Subscription type. (options: NGC_ADMIN_EVAL, NGC_ADMIN_NFR, NGC_ADMIN_COMMERCIAL) 

const (
	AdminOrgNewParamsProductSubscriptionsTypeNgcAdminEval       AdminOrgNewParamsProductSubscriptionsType = "NGC_ADMIN_EVAL"
	AdminOrgNewParamsProductSubscriptionsTypeNgcAdminNfr        AdminOrgNewParamsProductSubscriptionsType = "NGC_ADMIN_NFR"
	AdminOrgNewParamsProductSubscriptionsTypeNgcAdminCommercial AdminOrgNewParamsProductSubscriptionsType = "NGC_ADMIN_COMMERCIAL"
)

func (AdminOrgNewParamsProductSubscriptionsType) IsKnown 

func (r AdminOrgNewParamsProductSubscriptionsType) IsKnown() bool

type AdminOrgNewParamsType 

type AdminOrgNewParamsType string
const (
	AdminOrgNewParamsTypeUnknown    AdminOrgNewParamsType = "UNKNOWN"
	AdminOrgNewParamsTypeCloud      AdminOrgNewParamsType = "CLOUD"
	AdminOrgNewParamsTypeEnterprise AdminOrgNewParamsType = "ENTERPRISE"
	AdminOrgNewParamsTypeIndividual AdminOrgNewParamsType = "INDIVIDUAL"
)

func (AdminOrgNewParamsType) IsKnown 

func (r AdminOrgNewParamsType) IsKnown() bool

type AdminOrgOffboardedListParams 

type AdminOrgOffboardedListParams struct {
	// The page number of result
	PageNumber param.Field[int64] `query:"page-number"`
	// The page size of result
	PageSize param.Field[int64] `query:"page-size"`
}

func (AdminOrgOffboardedListParams) URLQuery 

func (r AdminOrgOffboardedListParams) URLQuery() (v url.Values)

URLQuery serializes AdminOrgOffboardedListParams's query parameters as `url.Values`.

type AdminOrgOffboardedListResponse 

type AdminOrgOffboardedListResponse struct {
	// Unique Id of this team.
	ID int64 `json:"id"`
	// Org Owner Alternate Contact
	AlternateContact AdminOrgOffboardedListResponseAlternateContact `json:"alternateContact"`
	// Billing account ID.
	BillingAccountID string `json:"billingAccountId"`
	// Identifies if the org can be reused.
	CanAddOn bool `json:"canAddOn"`
	// ISO country code of the organization.
	Country string `json:"country"`
	// Optional description of the organization.
	Description string `json:"description"`
	// Name of the organization that will be shown to users.
	DisplayName string `json:"displayName"`
	// Identity Provider ID.
	IdpID string `json:"idpId"`
	// Industry of the organization.
	Industry string `json:"industry"`
	// Infinity manager setting definition
	InfinityManagerSettings AdminOrgOffboardedListResponseInfinityManagerSettings `json:"infinityManagerSettings"`
	// Dataset Service enable flag for an organization
	IsDatasetServiceEnabled bool `json:"isDatasetServiceEnabled"`
	// Is NVIDIA internal org or not
	IsInternal bool `json:"isInternal"`
	// Indicates when the org is a proto org
	IsProto bool `json:"isProto"`
	// Quick Start enable flag for an organization
	IsQuickStartEnabled bool `json:"isQuickStartEnabled"`
	// If a server side encryption is enabled for private registry (models, resources)
	IsRegistrySseEnabled bool `json:"isRegistrySSEEnabled"`
	// Secrets Manager Service enable flag for an organization
	IsSecretsManagerServiceEnabled bool `json:"isSecretsManagerServiceEnabled"`
	// Secure Credential Sharing Service enable flag for an organization
	IsSecureCredentialSharingServiceEnabled bool `json:"isSecureCredentialSharingServiceEnabled"`
	// If a separate influx db used for an organization in BCP for job telemetry
	IsSeparateInfluxDBUsed bool `json:"isSeparateInfluxDbUsed"`
	// Organization name.
	Name string `json:"name"`
	// NVIDIA Cloud Account Number.
	Nan string `json:"nan"`
	// Org owner.
	OrgOwner AdminOrgOffboardedListResponseOrgOwner `json:"orgOwner"`
	// Org owners
	OrgOwners []AdminOrgOffboardedListResponseOrgOwner `json:"orgOwners"`
	// Product end customer salesforce.com Id (external customer Id). pecSfdcId is for
	// EMS (entitlement management service) to track external paid customer.
	PecSfdcID            string                                              `json:"pecSfdcId"`
	ProductEnablements   []AdminOrgOffboardedListResponseProductEnablement   `json:"productEnablements"`
	ProductSubscriptions []AdminOrgOffboardedListResponseProductSubscription `json:"productSubscriptions"`
	// Repo scan setting definition
	RepoScanSettings AdminOrgOffboardedListResponseRepoScanSettings `json:"repoScanSettings"`
	Type             AdminOrgOffboardedListResponseType             `json:"type"`
	// Users information.
	UsersInfo AdminOrgOffboardedListResponseUsersInfo `json:"usersInfo"`
	JSON      adminOrgOffboardedListResponseJSON      `json:"-"`
}

Information about the Organization

func (*AdminOrgOffboardedListResponse) UnmarshalJSON 

func (r *AdminOrgOffboardedListResponse) UnmarshalJSON(data []byte) (err error)

type AdminOrgOffboardedListResponseAlternateContact 

type AdminOrgOffboardedListResponseAlternateContact struct {
	// Alternate contact's email.
	Email string `json:"email"`
	// Full name of the alternate contact.
	FullName string                                             `json:"fullName"`
	JSON     adminOrgOffboardedListResponseAlternateContactJSON `json:"-"`
}

Org Owner Alternate Contact

func (*AdminOrgOffboardedListResponseAlternateContact) UnmarshalJSON 

func (r *AdminOrgOffboardedListResponseAlternateContact) UnmarshalJSON(data []byte) (err error)

type AdminOrgOffboardedListResponseInfinityManagerSettings 

type AdminOrgOffboardedListResponseInfinityManagerSettings struct {
	// Enable the infinity manager or not. Used both in org and team level object
	InfinityManagerEnabled bool `json:"infinityManagerEnabled"`
	// Allow override settings at team level. Only used in org level object
	InfinityManagerEnableTeamOverride bool                                                      `json:"infinityManagerEnableTeamOverride"`
	JSON                              adminOrgOffboardedListResponseInfinityManagerSettingsJSON `json:"-"`
}

Infinity manager setting definition

func (*AdminOrgOffboardedListResponseInfinityManagerSettings) UnmarshalJSON 

func (r *AdminOrgOffboardedListResponseInfinityManagerSettings) UnmarshalJSON(data []byte) (err error)

type AdminOrgOffboardedListResponseOrgOwner 

type AdminOrgOffboardedListResponseOrgOwner struct {
	// Email address of the org owner.
	Email string `json:"email,required"`
	// Org owner name.
	FullName string `json:"fullName,required"`
	// Last time the org owner logged in.
	LastLoginDate string                                     `json:"lastLoginDate"`
	JSON          adminOrgOffboardedListResponseOrgOwnerJSON `json:"-"`
}

Org owner.

func (*AdminOrgOffboardedListResponseOrgOwner) UnmarshalJSON 

func (r *AdminOrgOffboardedListResponseOrgOwner) UnmarshalJSON(data []byte) (err error)

type AdminOrgOffboardedListResponseProductEnablement 

type AdminOrgOffboardedListResponseProductEnablement struct {
	// Product Name (NVAIE, BASE_COMMAND, REGISTRY, etc)
	ProductName string `json:"productName,required"`
	// Product Enablement Types
	Type AdminOrgOffboardedListResponseProductEnablementsType `json:"type,required"`
	// Date on which the subscription expires. The subscription is invalid after this
	// date. (yyyy-MM-dd)
	ExpirationDate string                                                     `json:"expirationDate"`
	PoDetails      []AdminOrgOffboardedListResponseProductEnablementsPoDetail `json:"poDetails"`
	JSON           adminOrgOffboardedListResponseProductEnablementJSON        `json:"-"`
}

Product Enablement

func (*AdminOrgOffboardedListResponseProductEnablement) UnmarshalJSON 

func (r *AdminOrgOffboardedListResponseProductEnablement) UnmarshalJSON(data []byte) (err error)

type AdminOrgOffboardedListResponseProductEnablementsPoDetail 

type AdminOrgOffboardedListResponseProductEnablementsPoDetail struct {
	// Entitlement identifier.
	EntitlementID string `json:"entitlementId"`
	// PAK (Product Activation Key) identifier.
	PkID string                                                       `json:"pkId"`
	JSON adminOrgOffboardedListResponseProductEnablementsPoDetailJSON `json:"-"`
}

Purchase Order.

func (*AdminOrgOffboardedListResponseProductEnablementsPoDetail) UnmarshalJSON 

func (r *AdminOrgOffboardedListResponseProductEnablementsPoDetail) UnmarshalJSON(data []byte) (err error)

type AdminOrgOffboardedListResponseProductEnablementsType 

type AdminOrgOffboardedListResponseProductEnablementsType string

Product Enablement Types 

const (
	AdminOrgOffboardedListResponseProductEnablementsTypeNgcAdminEval       AdminOrgOffboardedListResponseProductEnablementsType = "NGC_ADMIN_EVAL"
	AdminOrgOffboardedListResponseProductEnablementsTypeNgcAdminNfr        AdminOrgOffboardedListResponseProductEnablementsType = "NGC_ADMIN_NFR"
	AdminOrgOffboardedListResponseProductEnablementsTypeNgcAdminCommercial AdminOrgOffboardedListResponseProductEnablementsType = "NGC_ADMIN_COMMERCIAL"
	AdminOrgOffboardedListResponseProductEnablementsTypeEmsEval            AdminOrgOffboardedListResponseProductEnablementsType = "EMS_EVAL"
	AdminOrgOffboardedListResponseProductEnablementsTypeEmsNfr             AdminOrgOffboardedListResponseProductEnablementsType = "EMS_NFR"
	AdminOrgOffboardedListResponseProductEnablementsTypeEmsCommercial      AdminOrgOffboardedListResponseProductEnablementsType = "EMS_COMMERCIAL"
	AdminOrgOffboardedListResponseProductEnablementsTypeNgcAdminDeveloper  AdminOrgOffboardedListResponseProductEnablementsType = "NGC_ADMIN_DEVELOPER"
)

func (AdminOrgOffboardedListResponseProductEnablementsType) IsKnown 

func (r AdminOrgOffboardedListResponseProductEnablementsType) IsKnown() bool

type AdminOrgOffboardedListResponseProductSubscription 

type AdminOrgOffboardedListResponseProductSubscription struct {
	// Product Name (NVAIE, BASE_COMMAND, FleetCommand, REGISTRY, etc).
	ProductName string `json:"productName,required"`
	// Unique entitlement identifier
	ID string `json:"id"`
	// EMS Subscription type. (options: EMS_EVAL, EMS_NFR and EMS_COMMERCIAL)
	EmsEntitlementType AdminOrgOffboardedListResponseProductSubscriptionsEmsEntitlementType `json:"emsEntitlementType"`
	// Date on which the subscription expires. The subscription is invalid after this
	// date. (yyyy-MM-dd)
	ExpirationDate string `json:"expirationDate"`
	// Date on which the subscription becomes active. (yyyy-MM-dd)
	StartDate string `json:"startDate"`
	// Subscription type. (options: NGC_ADMIN_EVAL, NGC_ADMIN_NFR,
	// NGC_ADMIN_COMMERCIAL)
	Type AdminOrgOffboardedListResponseProductSubscriptionsType `json:"type"`
	JSON adminOrgOffboardedListResponseProductSubscriptionJSON  `json:"-"`
}

Product Subscription

func (*AdminOrgOffboardedListResponseProductSubscription) UnmarshalJSON 

func (r *AdminOrgOffboardedListResponseProductSubscription) UnmarshalJSON(data []byte) (err error)

type AdminOrgOffboardedListResponseProductSubscriptionsEmsEntitlementType 

type AdminOrgOffboardedListResponseProductSubscriptionsEmsEntitlementType string

EMS Subscription type. (options: EMS_EVAL, EMS_NFR and EMS_COMMERCIAL) 

const (
	AdminOrgOffboardedListResponseProductSubscriptionsEmsEntitlementTypeEmsEval       AdminOrgOffboardedListResponseProductSubscriptionsEmsEntitlementType = "EMS_EVAL"
	AdminOrgOffboardedListResponseProductSubscriptionsEmsEntitlementTypeEmsNfr        AdminOrgOffboardedListResponseProductSubscriptionsEmsEntitlementType = "EMS_NFR"
	AdminOrgOffboardedListResponseProductSubscriptionsEmsEntitlementTypeEmsCommerical AdminOrgOffboardedListResponseProductSubscriptionsEmsEntitlementType = "EMS_COMMERICAL"
	AdminOrgOffboardedListResponseProductSubscriptionsEmsEntitlementTypeEmsCommercial AdminOrgOffboardedListResponseProductSubscriptionsEmsEntitlementType = "EMS_COMMERCIAL"
)

func (AdminOrgOffboardedListResponseProductSubscriptionsEmsEntitlementType) IsKnown 

func (r AdminOrgOffboardedListResponseProductSubscriptionsEmsEntitlementType) IsKnown() bool

type AdminOrgOffboardedListResponseProductSubscriptionsType 

type AdminOrgOffboardedListResponseProductSubscriptionsType string

Subscription type. (options: NGC_ADMIN_EVAL, NGC_ADMIN_NFR, NGC_ADMIN_COMMERCIAL) 

const (
	AdminOrgOffboardedListResponseProductSubscriptionsTypeNgcAdminEval       AdminOrgOffboardedListResponseProductSubscriptionsType = "NGC_ADMIN_EVAL"
	AdminOrgOffboardedListResponseProductSubscriptionsTypeNgcAdminNfr        AdminOrgOffboardedListResponseProductSubscriptionsType = "NGC_ADMIN_NFR"
	AdminOrgOffboardedListResponseProductSubscriptionsTypeNgcAdminCommercial AdminOrgOffboardedListResponseProductSubscriptionsType = "NGC_ADMIN_COMMERCIAL"
)

func (AdminOrgOffboardedListResponseProductSubscriptionsType) IsKnown 

func (r AdminOrgOffboardedListResponseProductSubscriptionsType) IsKnown() bool

type AdminOrgOffboardedListResponseRepoScanSettings 

type AdminOrgOffboardedListResponseRepoScanSettings struct {
	// Allow org admin to override the org level repo scan settings
	RepoScanAllowOverride bool `json:"repoScanAllowOverride"`
	// Allow repository scanning by default
	RepoScanByDefault bool `json:"repoScanByDefault"`
	// Enable the repository scan or not. Only used in org level object
	RepoScanEnabled bool `json:"repoScanEnabled"`
	// Sends notification to end user after scanning is done
	RepoScanEnableNotifications bool `json:"repoScanEnableNotifications"`
	// Allow override settings at team level. Only used in org level object
	RepoScanEnableTeamOverride bool `json:"repoScanEnableTeamOverride"`
	// Allow showing scan results to CLI or UI
	RepoScanShowResults bool                                               `json:"repoScanShowResults"`
	JSON                adminOrgOffboardedListResponseRepoScanSettingsJSON `json:"-"`
}

Repo scan setting definition

func (*AdminOrgOffboardedListResponseRepoScanSettings) UnmarshalJSON 

func (r *AdminOrgOffboardedListResponseRepoScanSettings) UnmarshalJSON(data []byte) (err error)

type AdminOrgOffboardedListResponseType 

type AdminOrgOffboardedListResponseType string
const (
	AdminOrgOffboardedListResponseTypeUnknown    AdminOrgOffboardedListResponseType = "UNKNOWN"
	AdminOrgOffboardedListResponseTypeCloud      AdminOrgOffboardedListResponseType = "CLOUD"
	AdminOrgOffboardedListResponseTypeEnterprise AdminOrgOffboardedListResponseType = "ENTERPRISE"
	AdminOrgOffboardedListResponseTypeIndividual AdminOrgOffboardedListResponseType = "INDIVIDUAL"
)

func (AdminOrgOffboardedListResponseType) IsKnown 

func (r AdminOrgOffboardedListResponseType) IsKnown() bool

type AdminOrgOffboardedListResponseUsersInfo 

type AdminOrgOffboardedListResponseUsersInfo struct {
	// Total number of users.
	TotalUsers int64                                       `json:"totalUsers"`
	JSON       adminOrgOffboardedListResponseUsersInfoJSON `json:"-"`
}

Users information.

func (*AdminOrgOffboardedListResponseUsersInfo) UnmarshalJSON 

func (r *AdminOrgOffboardedListResponseUsersInfo) UnmarshalJSON(data []byte) (err error)

type AdminOrgOffboardedService 

type AdminOrgOffboardedService struct {
	Options []option.RequestOption
}

AdminOrgOffboardedService contains methods and other services that help with interacting with the ngc API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewAdminOrgOffboardedService method instead.

func NewAdminOrgOffboardedService 

func NewAdminOrgOffboardedService(opts ...option.RequestOption) (r *AdminOrgOffboardedService)

NewAdminOrgOffboardedService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*AdminOrgOffboardedService) List 

func (r *AdminOrgOffboardedService) List(ctx context.Context, query AdminOrgOffboardedListParams, opts ...option.RequestOption) (res *pagination.PageNumberOrganizations[AdminOrgOffboardedListResponse], err error)

List all Offboarded organizations.

func (*AdminOrgOffboardedService) ListAutoPaging 

func (r *AdminOrgOffboardedService) ListAutoPaging(ctx context.Context, query AdminOrgOffboardedListParams, opts ...option.RequestOption) *pagination.PageNumberOrganizationsAutoPager[AdminOrgOffboardedListResponse]

List all Offboarded organizations.

type AdminOrgRegistryMeteringDownsampleParams 

type AdminOrgRegistryMeteringDownsampleParams struct {
	// request params for getting metering usage
	Q param.Field[AdminOrgRegistryMeteringDownsampleParamsQ] `query:"q,required"`
}

func (AdminOrgRegistryMeteringDownsampleParams) URLQuery 

func (r AdminOrgRegistryMeteringDownsampleParams) URLQuery() (v url.Values)

URLQuery serializes AdminOrgRegistryMeteringDownsampleParams's query parameters as `url.Values`.

type AdminOrgRegistryMeteringDownsampleParamsQ 

type AdminOrgRegistryMeteringDownsampleParamsQ struct {
	Measurements param.Field[[]AdminOrgRegistryMeteringDownsampleParamsQMeasurement] `query:"measurements"`
}

request params for getting metering usage

func (AdminOrgRegistryMeteringDownsampleParamsQ) URLQuery 

func (r AdminOrgRegistryMeteringDownsampleParamsQ) URLQuery() (v url.Values)

URLQuery serializes AdminOrgRegistryMeteringDownsampleParamsQ's query parameters as `url.Values`.

type AdminOrgRegistryMeteringDownsampleParamsQMeasurement 

type AdminOrgRegistryMeteringDownsampleParamsQMeasurement struct {
	// this replaces all null values in an output stream with a non-null value that is
	// provided.
	Fill param.Field[float64] `query:"fill"`
	// end time range for the data, in ISO formate, yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
	FromDate param.Field[string] `query:"fromDate"`
	// group by specific tags
	GroupBy param.Field[[]string] `query:"groupBy"`
	// time period to aggregate the data over with, in seconds. If none provided, raw
	// data will be returned.
	PeriodInSeconds param.Field[float64] `query:"periodInSeconds"`
	// start time range for the data, in ISO formate, yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
	ToDate param.Field[string]                                                    `query:"toDate"`
	Type   param.Field[AdminOrgRegistryMeteringDownsampleParamsQMeasurementsType] `query:"type"`
}

object used for sending metering query parameter request

func (AdminOrgRegistryMeteringDownsampleParamsQMeasurement) URLQuery 

func (r AdminOrgRegistryMeteringDownsampleParamsQMeasurement) URLQuery() (v url.Values)

URLQuery serializes AdminOrgRegistryMeteringDownsampleParamsQMeasurement's query parameters as `url.Values`.

type AdminOrgRegistryMeteringDownsampleParamsQMeasurementsType 

type AdminOrgRegistryMeteringDownsampleParamsQMeasurementsType string
const (
	AdminOrgRegistryMeteringDownsampleParamsQMeasurementsTypeEgxGPUUtilizationDaily                   AdminOrgRegistryMeteringDownsampleParamsQMeasurementsType = "EGX_GPU_UTILIZATION_DAILY"
	AdminOrgRegistryMeteringDownsampleParamsQMeasurementsTypeFleetCommandGPUUtilizationDaily          AdminOrgRegistryMeteringDownsampleParamsQMeasurementsType = "FLEET_COMMAND_GPU_UTILIZATION_DAILY"
	AdminOrgRegistryMeteringDownsampleParamsQMeasurementsTypeEgxLogStorageUtilizationDaily            AdminOrgRegistryMeteringDownsampleParamsQMeasurementsType = "EGX_LOG_STORAGE_UTILIZATION_DAILY"
	AdminOrgRegistryMeteringDownsampleParamsQMeasurementsTypeFleetCommandLogStorageUtilizationDaily   AdminOrgRegistryMeteringDownsampleParamsQMeasurementsType = "FLEET_COMMAND_LOG_STORAGE_UTILIZATION_DAILY"
	AdminOrgRegistryMeteringDownsampleParamsQMeasurementsTypeRegistryStorageUtilizationDaily          AdminOrgRegistryMeteringDownsampleParamsQMeasurementsType = "REGISTRY_STORAGE_UTILIZATION_DAILY"
	AdminOrgRegistryMeteringDownsampleParamsQMeasurementsTypeEgxGPUUtilizationMonthly                 AdminOrgRegistryMeteringDownsampleParamsQMeasurementsType = "EGX_GPU_UTILIZATION_MONTHLY"
	AdminOrgRegistryMeteringDownsampleParamsQMeasurementsTypeFleetCommandGPUUtilizationMonthly        AdminOrgRegistryMeteringDownsampleParamsQMeasurementsType = "FLEET_COMMAND_GPU_UTILIZATION_MONTHLY"
	AdminOrgRegistryMeteringDownsampleParamsQMeasurementsTypeEgxLogStorageUtilizationMonthly          AdminOrgRegistryMeteringDownsampleParamsQMeasurementsType = "EGX_LOG_STORAGE_UTILIZATION_MONTHLY"
	AdminOrgRegistryMeteringDownsampleParamsQMeasurementsTypeFleetCommandLogStorageUtilizationMonthly AdminOrgRegistryMeteringDownsampleParamsQMeasurementsType = "FLEET_COMMAND_LOG_STORAGE_UTILIZATION_MONTHLY"
	AdminOrgRegistryMeteringDownsampleParamsQMeasurementsTypeRegistryStorageUtilizationMonthly        AdminOrgRegistryMeteringDownsampleParamsQMeasurementsType = "REGISTRY_STORAGE_UTILIZATION_MONTHLY"
)

func (AdminOrgRegistryMeteringDownsampleParamsQMeasurementsType) IsKnown 

func (r AdminOrgRegistryMeteringDownsampleParamsQMeasurementsType) IsKnown() bool

type AdminOrgRegistryMeteringService 

type AdminOrgRegistryMeteringService struct {
	Options []option.RequestOption
}

AdminOrgRegistryMeteringService contains methods and other services that help with interacting with the ngc API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewAdminOrgRegistryMeteringService method instead.

func NewAdminOrgRegistryMeteringService 

func NewAdminOrgRegistryMeteringService(opts ...option.RequestOption) (r *AdminOrgRegistryMeteringService)

NewAdminOrgRegistryMeteringService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*AdminOrgRegistryMeteringService) Downsample 

func (r *AdminOrgRegistryMeteringService) Downsample(ctx context.Context, orgName string, query AdminOrgRegistryMeteringDownsampleParams, opts ...option.RequestOption) (res *shared.MeteringResultList, err error)

Run registry metering downsample

type AdminOrgRegistryService 

type AdminOrgRegistryService struct {
	Options  []option.RequestOption
	Metering *AdminOrgRegistryMeteringService
}

AdminOrgRegistryService contains methods and other services that help with interacting with the ngc API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewAdminOrgRegistryService method instead.

func NewAdminOrgRegistryService 

func NewAdminOrgRegistryService(opts ...option.RequestOption) (r *AdminOrgRegistryService)

NewAdminOrgRegistryService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

type AdminOrgService 

type AdminOrgService struct {
	Options    []option.RequestOption
	NcaIDs     *AdminOrgNcaIDService
	Offboarded *AdminOrgOffboardedService
	Teams      *AdminOrgTeamService
	Users      *AdminOrgUserService
}

AdminOrgService contains methods and other services that help with interacting with the ngc API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewAdminOrgService method instead.

func NewAdminOrgService 

func NewAdminOrgService(opts ...option.RequestOption) (r *AdminOrgService)

NewAdminOrgService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*AdminOrgService) List 

func (r *AdminOrgService) List(ctx context.Context, query AdminOrgListParams, opts ...option.RequestOption) (res *pagination.PageNumberOrganizations[AdminOrgListResponse], err error)

List all organizations. (SuperAdmin privileges required)

func (*AdminOrgService) ListAutoPaging 

func (r *AdminOrgService) ListAutoPaging(ctx context.Context, query AdminOrgListParams, opts ...option.RequestOption) *pagination.PageNumberOrganizationsAutoPager[AdminOrgListResponse]

List all organizations. (SuperAdmin privileges required)

func (*AdminOrgService) New 

func (r *AdminOrgService) New(ctx context.Context, params AdminOrgNewParams, opts ...option.RequestOption) (res *http.Response, err error)

OrgCreateRequest is used to create the organization or when no nca_id is provided upfront, the OrgCreateRequest is stored as proto org, and proto org flow initiates (SuperAdmin privileges required)

type AdminOrgTeamListParams 

type AdminOrgTeamListParams struct {
	// The page number of result
	PageNumber param.Field[int64] `query:"page-number"`
	// The page size of result
	PageSize param.Field[int64] `query:"page-size"`
	// Get all team that has scan allow override only
	ScanAllowOverride param.Field[bool] `query:"scan-allow-override"`
	// Get all team that has scan by default only
	ScanByDefault param.Field[bool] `query:"scan-by-default"`
	// Get all team that has scan show results only
	ScanShowResults param.Field[bool] `query:"scan-show-results"`
	// Team name to search
	TeamName param.Field[string] `query:"team-name"`
}

func (AdminOrgTeamListParams) URLQuery 

func (r AdminOrgTeamListParams) URLQuery() (v url.Values)

URLQuery serializes AdminOrgTeamListParams's query parameters as `url.Values`.

type AdminOrgTeamListResponse 

type AdminOrgTeamListResponse struct {
	// unique Id of this team.
	ID int64 `json:"id"`
	// description of the team
	Description string `json:"description"`
	// Infinity manager setting definition
	InfinityManagerSettings AdminOrgTeamListResponseInfinityManagerSettings `json:"infinityManagerSettings"`
	// indicates if the team is deleted or not
	IsDeleted bool `json:"isDeleted"`
	// team name
	Name string `json:"name"`
	// Repo scan setting definition
	RepoScanSettings AdminOrgTeamListResponseRepoScanSettings `json:"repoScanSettings"`
	JSON             adminOrgTeamListResponseJSON             `json:"-"`
}

Information about the team

func (*AdminOrgTeamListResponse) UnmarshalJSON 

func (r *AdminOrgTeamListResponse) UnmarshalJSON(data []byte) (err error)

type AdminOrgTeamListResponseInfinityManagerSettings 

type AdminOrgTeamListResponseInfinityManagerSettings struct {
	// Enable the infinity manager or not. Used both in org and team level object
	InfinityManagerEnabled bool `json:"infinityManagerEnabled"`
	// Allow override settings at team level. Only used in org level object
	InfinityManagerEnableTeamOverride bool                                                `json:"infinityManagerEnableTeamOverride"`
	JSON                              adminOrgTeamListResponseInfinityManagerSettingsJSON `json:"-"`
}

Infinity manager setting definition

func (*AdminOrgTeamListResponseInfinityManagerSettings) UnmarshalJSON 

func (r *AdminOrgTeamListResponseInfinityManagerSettings) UnmarshalJSON(data []byte) (err error)

type AdminOrgTeamListResponseRepoScanSettings 

type AdminOrgTeamListResponseRepoScanSettings struct {
	// Allow org admin to override the org level repo scan settings
	RepoScanAllowOverride bool `json:"repoScanAllowOverride"`
	// Allow repository scanning by default
	RepoScanByDefault bool `json:"repoScanByDefault"`
	// Enable the repository scan or not. Only used in org level object
	RepoScanEnabled bool `json:"repoScanEnabled"`
	// Sends notification to end user after scanning is done
	RepoScanEnableNotifications bool `json:"repoScanEnableNotifications"`
	// Allow override settings at team level. Only used in org level object
	RepoScanEnableTeamOverride bool `json:"repoScanEnableTeamOverride"`
	// Allow showing scan results to CLI or UI
	RepoScanShowResults bool                                         `json:"repoScanShowResults"`
	JSON                adminOrgTeamListResponseRepoScanSettingsJSON `json:"-"`
}

Repo scan setting definition

func (*AdminOrgTeamListResponseRepoScanSettings) UnmarshalJSON 

func (r *AdminOrgTeamListResponseRepoScanSettings) UnmarshalJSON(data []byte) (err error)

type AdminOrgTeamService 

type AdminOrgTeamService struct {
	Options []option.RequestOption
}

AdminOrgTeamService contains methods and other services that help with interacting with the ngc API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewAdminOrgTeamService method instead.

func NewAdminOrgTeamService 

func NewAdminOrgTeamService(opts ...option.RequestOption) (r *AdminOrgTeamService)

NewAdminOrgTeamService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*AdminOrgTeamService) List 

func (r *AdminOrgTeamService) List(ctx context.Context, orgName string, query AdminOrgTeamListParams, opts ...option.RequestOption) (res *pagination.PageNumberTeams[shared.AdminOrgTeamListResponse], err error)

List all Teams

func (*AdminOrgTeamService) ListAutoPaging 

func (r *AdminOrgTeamService) ListAutoPaging(ctx context.Context, orgName string, query AdminOrgTeamListParams, opts ...option.RequestOption) *pagination.PageNumberTeamsAutoPager[shared.AdminOrgTeamListResponse]

List all Teams

type AdminOrgTeamUserRemoveRoleParams 

type AdminOrgTeamUserRemoveRoleParams struct {
	Roles param.Field[[]string] `query:"roles"`
}

func (AdminOrgTeamUserRemoveRoleParams) URLQuery 

func (r AdminOrgTeamUserRemoveRoleParams) URLQuery() (v url.Values)

URLQuery serializes AdminOrgTeamUserRemoveRoleParams's query parameters as `url.Values`.

type AdminOrgTeamUserService 

type AdminOrgTeamUserService struct {
	Options []option.RequestOption
}

AdminOrgTeamUserService contains methods and other services that help with interacting with the ngc API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewAdminOrgTeamUserService method instead.

func NewAdminOrgTeamUserService 

func NewAdminOrgTeamUserService(opts ...option.RequestOption) (r *AdminOrgTeamUserService)

NewAdminOrgTeamUserService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*AdminOrgTeamUserService) RemoveRole 

func (r *AdminOrgTeamUserService) RemoveRole(ctx context.Context, orgName string, teamName string, id string, body AdminOrgTeamUserRemoveRoleParams, opts ...option.RequestOption) (res *shared.User, err error)

Remove user role in team (if the last role is removed, the user is removed from the team).

type AdminOrgUserService 

type AdminOrgUserService struct {
	Options []option.RequestOption
}

AdminOrgUserService contains methods and other services that help with interacting with the ngc API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewAdminOrgUserService method instead.

func NewAdminOrgUserService 

func NewAdminOrgUserService(opts ...option.RequestOption) (r *AdminOrgUserService)

NewAdminOrgUserService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

type AdminOrgValidateGetAllParams 

type AdminOrgValidateGetAllParams struct {
	// Validate Organization Parameters
	Q param.Field[AdminOrgValidateGetAllParamsQ] `query:"q,required"`
}

func (AdminOrgValidateGetAllParams) URLQuery 

func (r AdminOrgValidateGetAllParams) URLQuery() (v url.Values)

URLQuery serializes AdminOrgValidateGetAllParams's query parameters as `url.Values`.

type AdminOrgValidateGetAllParamsQ 

type AdminOrgValidateGetAllParamsQ struct {
	// Org owner.
	OrgOwner param.Field[AdminOrgValidateGetAllParamsQOrgOwner] `query:"orgOwner,required"`
	// Product end customer salesforce.com id (external customer id) for enterprise
	// product.
	PecSfdcID param.Field[string] `query:"pecSfdcId,required"`
	// Product Subscriptions.
	ProductSubscriptions param.Field[[]AdminOrgValidateGetAllParamsQProductSubscription] `query:"productSubscriptions,required"`
}

Validate Organization Parameters

func (AdminOrgValidateGetAllParamsQ) URLQuery 

func (r AdminOrgValidateGetAllParamsQ) URLQuery() (v url.Values)

URLQuery serializes AdminOrgValidateGetAllParamsQ's query parameters as `url.Values`.

type AdminOrgValidateGetAllParamsQOrgOwner 

type AdminOrgValidateGetAllParamsQOrgOwner struct {
	// Email address of the org owner.
	Email param.Field[string] `query:"email,required"`
	// Org owner name.
	FullName param.Field[string] `query:"fullName,required"`
	// Last time the org owner logged in.
	LastLoginDate param.Field[string] `query:"lastLoginDate"`
}

Org owner.

func (AdminOrgValidateGetAllParamsQOrgOwner) URLQuery 

func (r AdminOrgValidateGetAllParamsQOrgOwner) URLQuery() (v url.Values)

URLQuery serializes AdminOrgValidateGetAllParamsQOrgOwner's query parameters as `url.Values`.

type AdminOrgValidateGetAllParamsQProductSubscription 

type AdminOrgValidateGetAllParamsQProductSubscription struct {
	// Product Name (NVAIE, BASE_COMMAND, FleetCommand, REGISTRY, etc).
	ProductName param.Field[string] `query:"productName,required"`
	// Unique entitlement identifier
	ID param.Field[string] `query:"id"`
	// EMS Subscription type. (options: EMS_EVAL, EMS_NFR and EMS_COMMERCIAL)
	EmsEntitlementType param.Field[AdminOrgValidateGetAllParamsQProductSubscriptionsEmsEntitlementType] `query:"emsEntitlementType"`
	// Date on which the subscription expires. The subscription is invalid after this
	// date. (yyyy-MM-dd)
	ExpirationDate param.Field[string] `query:"expirationDate"`
	// Date on which the subscription becomes active. (yyyy-MM-dd)
	StartDate param.Field[string] `query:"startDate"`
	// Subscription type. (options: NGC_ADMIN_EVAL, NGC_ADMIN_NFR,
	// NGC_ADMIN_COMMERCIAL)
	Type param.Field[AdminOrgValidateGetAllParamsQProductSubscriptionsType] `query:"type"`
}

Product Subscription

func (AdminOrgValidateGetAllParamsQProductSubscription) URLQuery 

func (r AdminOrgValidateGetAllParamsQProductSubscription) URLQuery() (v url.Values)

URLQuery serializes AdminOrgValidateGetAllParamsQProductSubscription's query parameters as `url.Values`.

type AdminOrgValidateGetAllParamsQProductSubscriptionsEmsEntitlementType 

type AdminOrgValidateGetAllParamsQProductSubscriptionsEmsEntitlementType string

EMS Subscription type. (options: EMS_EVAL, EMS_NFR and EMS_COMMERCIAL) 

const (
	AdminOrgValidateGetAllParamsQProductSubscriptionsEmsEntitlementTypeEmsEval       AdminOrgValidateGetAllParamsQProductSubscriptionsEmsEntitlementType = "EMS_EVAL"
	AdminOrgValidateGetAllParamsQProductSubscriptionsEmsEntitlementTypeEmsNfr        AdminOrgValidateGetAllParamsQProductSubscriptionsEmsEntitlementType = "EMS_NFR"
	AdminOrgValidateGetAllParamsQProductSubscriptionsEmsEntitlementTypeEmsCommerical AdminOrgValidateGetAllParamsQProductSubscriptionsEmsEntitlementType = "EMS_COMMERICAL"
	AdminOrgValidateGetAllParamsQProductSubscriptionsEmsEntitlementTypeEmsCommercial AdminOrgValidateGetAllParamsQProductSubscriptionsEmsEntitlementType = "EMS_COMMERCIAL"
)

func (AdminOrgValidateGetAllParamsQProductSubscriptionsEmsEntitlementType) IsKnown 

func (r AdminOrgValidateGetAllParamsQProductSubscriptionsEmsEntitlementType) IsKnown() bool

type AdminOrgValidateGetAllParamsQProductSubscriptionsType 

type AdminOrgValidateGetAllParamsQProductSubscriptionsType string

Subscription type. (options: NGC_ADMIN_EVAL, NGC_ADMIN_NFR, NGC_ADMIN_COMMERCIAL) 

const (
	AdminOrgValidateGetAllParamsQProductSubscriptionsTypeNgcAdminEval       AdminOrgValidateGetAllParamsQProductSubscriptionsType = "NGC_ADMIN_EVAL"
	AdminOrgValidateGetAllParamsQProductSubscriptionsTypeNgcAdminNfr        AdminOrgValidateGetAllParamsQProductSubscriptionsType = "NGC_ADMIN_NFR"
	AdminOrgValidateGetAllParamsQProductSubscriptionsTypeNgcAdminCommercial AdminOrgValidateGetAllParamsQProductSubscriptionsType = "NGC_ADMIN_COMMERCIAL"
)

func (AdminOrgValidateGetAllParamsQProductSubscriptionsType) IsKnown 

func (r AdminOrgValidateGetAllParamsQProductSubscriptionsType) IsKnown() bool

type AdminOrgValidateService 

type AdminOrgValidateService struct {
	Options []option.RequestOption
}

AdminOrgValidateService contains methods and other services that help with interacting with the ngc API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewAdminOrgValidateService method instead.

func NewAdminOrgValidateService 

func NewAdminOrgValidateService(opts ...option.RequestOption) (r *AdminOrgValidateService)

NewAdminOrgValidateService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*AdminOrgValidateService) GetAll 

func (r *AdminOrgValidateService) GetAll(ctx context.Context, query AdminOrgValidateGetAllParams, opts ...option.RequestOption) (res *OrgList, err error)

List all organizations that match the validate org params

type AdminService 

type AdminService struct {
	Options []option.RequestOption
	Orgs    *AdminOrgService
	Users   *AdminUserService
	Org     *AdminOrgService
}

AdminService contains methods and other services that help with interacting with the ngc API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewAdminService method instead.

func NewAdminService 

func NewAdminService(opts ...option.RequestOption) (r *AdminService)

NewAdminService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

type AdminUserInviteParams 

type AdminUserInviteParams struct {
	Email param.Field[string] `query:"email,required"`
	// Boolean to send email notification, default is true
	SendEmail param.Field[bool] `query:"send-email"`
}

func (AdminUserInviteParams) URLQuery 

func (r AdminUserInviteParams) URLQuery() (v url.Values)

URLQuery serializes AdminUserInviteParams's query parameters as `url.Values`.

type AdminUserMeParams 

type AdminUserMeParams struct {
	OrgName param.Field[string] `query:"org-name"`
}

func (AdminUserMeParams) URLQuery 

func (r AdminUserMeParams) URLQuery() (v url.Values)

URLQuery serializes AdminUserMeParams's query parameters as `url.Values`.

type AdminUserOrgOwnerBackfillResponse 

type AdminUserOrgOwnerBackfillResponse struct {
	RequestStatus AdminUserOrgOwnerBackfillResponseRequestStatus `json:"requestStatus"`
	JSON          adminUserOrgOwnerBackfillResponseJSON          `json:"-"`
}

func (*AdminUserOrgOwnerBackfillResponse) UnmarshalJSON 

func (r *AdminUserOrgOwnerBackfillResponse) UnmarshalJSON(data []byte) (err error)

type AdminUserOrgOwnerBackfillResponseRequestStatus 

type AdminUserOrgOwnerBackfillResponseRequestStatus struct {
	RequestID string `json:"requestId"`
	ServerID  string `json:"serverId"`
	// Describes response status reported by the server.
	StatusCode        AdminUserOrgOwnerBackfillResponseRequestStatusStatusCode `json:"statusCode"`
	StatusDescription string                                                   `json:"statusDescription"`
	JSON              adminUserOrgOwnerBackfillResponseRequestStatusJSON       `json:"-"`
}

func (*AdminUserOrgOwnerBackfillResponseRequestStatus) UnmarshalJSON 

func (r *AdminUserOrgOwnerBackfillResponseRequestStatus) UnmarshalJSON(data []byte) (err error)

type AdminUserOrgOwnerBackfillResponseRequestStatusStatusCode 

type AdminUserOrgOwnerBackfillResponseRequestStatusStatusCode string

Describes response status reported by the server. 

const (
	AdminUserOrgOwnerBackfillResponseRequestStatusStatusCodeUnknown                    AdminUserOrgOwnerBackfillResponseRequestStatusStatusCode = "UNKNOWN"
	AdminUserOrgOwnerBackfillResponseRequestStatusStatusCodeSuccess                    AdminUserOrgOwnerBackfillResponseRequestStatusStatusCode = "SUCCESS"
	AdminUserOrgOwnerBackfillResponseRequestStatusStatusCodeUnauthorized               AdminUserOrgOwnerBackfillResponseRequestStatusStatusCode = "UNAUTHORIZED"
	AdminUserOrgOwnerBackfillResponseRequestStatusStatusCodePaymentRequired            AdminUserOrgOwnerBackfillResponseRequestStatusStatusCode = "PAYMENT_REQUIRED"
	AdminUserOrgOwnerBackfillResponseRequestStatusStatusCodeForbidden                  AdminUserOrgOwnerBackfillResponseRequestStatusStatusCode = "FORBIDDEN"
	AdminUserOrgOwnerBackfillResponseRequestStatusStatusCodeTimeout                    AdminUserOrgOwnerBackfillResponseRequestStatusStatusCode = "TIMEOUT"
	AdminUserOrgOwnerBackfillResponseRequestStatusStatusCodeExists                     AdminUserOrgOwnerBackfillResponseRequestStatusStatusCode = "EXISTS"
	AdminUserOrgOwnerBackfillResponseRequestStatusStatusCodeNotFound                   AdminUserOrgOwnerBackfillResponseRequestStatusStatusCode = "NOT_FOUND"
	AdminUserOrgOwnerBackfillResponseRequestStatusStatusCodeInternalError              AdminUserOrgOwnerBackfillResponseRequestStatusStatusCode = "INTERNAL_ERROR"
	AdminUserOrgOwnerBackfillResponseRequestStatusStatusCodeInvalidRequest             AdminUserOrgOwnerBackfillResponseRequestStatusStatusCode = "INVALID_REQUEST"
	AdminUserOrgOwnerBackfillResponseRequestStatusStatusCodeInvalidRequestVersion      AdminUserOrgOwnerBackfillResponseRequestStatusStatusCode = "INVALID_REQUEST_VERSION"
	AdminUserOrgOwnerBackfillResponseRequestStatusStatusCodeInvalidRequestData         AdminUserOrgOwnerBackfillResponseRequestStatusStatusCode = "INVALID_REQUEST_DATA"
	AdminUserOrgOwnerBackfillResponseRequestStatusStatusCodeMethodNotAllowed           AdminUserOrgOwnerBackfillResponseRequestStatusStatusCode = "METHOD_NOT_ALLOWED"
	AdminUserOrgOwnerBackfillResponseRequestStatusStatusCodeConflict                   AdminUserOrgOwnerBackfillResponseRequestStatusStatusCode = "CONFLICT"
	AdminUserOrgOwnerBackfillResponseRequestStatusStatusCodeUnprocessableEntity        AdminUserOrgOwnerBackfillResponseRequestStatusStatusCode = "UNPROCESSABLE_ENTITY"
	AdminUserOrgOwnerBackfillResponseRequestStatusStatusCodeTooManyRequests            AdminUserOrgOwnerBackfillResponseRequestStatusStatusCode = "TOO_MANY_REQUESTS"
	AdminUserOrgOwnerBackfillResponseRequestStatusStatusCodeInsufficientStorage        AdminUserOrgOwnerBackfillResponseRequestStatusStatusCode = "INSUFFICIENT_STORAGE"
	AdminUserOrgOwnerBackfillResponseRequestStatusStatusCodeServiceUnavailable         AdminUserOrgOwnerBackfillResponseRequestStatusStatusCode = "SERVICE_UNAVAILABLE"
	AdminUserOrgOwnerBackfillResponseRequestStatusStatusCodePayloadTooLarge            AdminUserOrgOwnerBackfillResponseRequestStatusStatusCode = "PAYLOAD_TOO_LARGE"
	AdminUserOrgOwnerBackfillResponseRequestStatusStatusCodeNotAcceptable              AdminUserOrgOwnerBackfillResponseRequestStatusStatusCode = "NOT_ACCEPTABLE"
	AdminUserOrgOwnerBackfillResponseRequestStatusStatusCodeUnavailableForLegalReasons AdminUserOrgOwnerBackfillResponseRequestStatusStatusCode = "UNAVAILABLE_FOR_LEGAL_REASONS"
	AdminUserOrgOwnerBackfillResponseRequestStatusStatusCodeBadGateway                 AdminUserOrgOwnerBackfillResponseRequestStatusStatusCode = "BAD_GATEWAY"
)

func (AdminUserOrgOwnerBackfillResponseRequestStatusStatusCode) IsKnown 

func (r AdminUserOrgOwnerBackfillResponseRequestStatusStatusCode) IsKnown() bool

type AdminUserService 

type AdminUserService struct {
	Options []option.RequestOption
}

AdminUserService contains methods and other services that help with interacting with the ngc API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewAdminUserService method instead.

func NewAdminUserService 

func NewAdminUserService(opts ...option.RequestOption) (r *AdminUserService)

NewAdminUserService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*AdminUserService) Get 

func (r *AdminUserService) Get(ctx context.Context, id string, opts ...option.RequestOption) (res *shared.User, err error)

Get User details

func (*AdminUserService) Invite 

func (r *AdminUserService) Invite(ctx context.Context, body AdminUserInviteParams, opts ...option.RequestOption) (res *shared.User, err error)

Invite an existing user again (Super Admin privileges required)

func (*AdminUserService) Me 

func (r *AdminUserService) Me(ctx context.Context, query AdminUserMeParams, opts ...option.RequestOption) (res *shared.User, err error)

What am I? Admin version, shows more info than regular endpoint

func (*AdminUserService) OrgOwnerBackfill 

func (r *AdminUserService) OrgOwnerBackfill(ctx context.Context, userID int64, opts ...option.RequestOption) (res *AdminUserOrgOwnerBackfillResponse, err error)

Backfill the org owner for individual users

type AuditLogsPresignedURL 

type AuditLogsPresignedURL struct {
	// Presign url for user to download audit logs
	AuditLogsPresignedURL string                             `json:"auditLogsPresignedUrl"`
	RequestStatus         AuditLogsPresignedURLRequestStatus `json:"requestStatus"`
	JSON                  auditLogsPresignedURLJSON          `json:"-"`
}

List of audit logs object

func (*AuditLogsPresignedURL) UnmarshalJSON 

func (r *AuditLogsPresignedURL) UnmarshalJSON(data []byte) (err error)

type AuditLogsPresignedURLRequestStatus 

type AuditLogsPresignedURLRequestStatus struct {
	RequestID string `json:"requestId"`
	ServerID  string `json:"serverId"`
	// Describes response status reported by the server.
	StatusCode        AuditLogsPresignedURLRequestStatusStatusCode `json:"statusCode"`
	StatusDescription string                                       `json:"statusDescription"`
	JSON              auditLogsPresignedURLRequestStatusJSON       `json:"-"`
}

func (*AuditLogsPresignedURLRequestStatus) UnmarshalJSON 

func (r *AuditLogsPresignedURLRequestStatus) UnmarshalJSON(data []byte) (err error)

type AuditLogsPresignedURLRequestStatusStatusCode 

type AuditLogsPresignedURLRequestStatusStatusCode string

Describes response status reported by the server. 

const (
	AuditLogsPresignedURLRequestStatusStatusCodeUnknown                    AuditLogsPresignedURLRequestStatusStatusCode = "UNKNOWN"
	AuditLogsPresignedURLRequestStatusStatusCodeSuccess                    AuditLogsPresignedURLRequestStatusStatusCode = "SUCCESS"
	AuditLogsPresignedURLRequestStatusStatusCodeUnauthorized               AuditLogsPresignedURLRequestStatusStatusCode = "UNAUTHORIZED"
	AuditLogsPresignedURLRequestStatusStatusCodePaymentRequired            AuditLogsPresignedURLRequestStatusStatusCode = "PAYMENT_REQUIRED"
	AuditLogsPresignedURLRequestStatusStatusCodeForbidden                  AuditLogsPresignedURLRequestStatusStatusCode = "FORBIDDEN"
	AuditLogsPresignedURLRequestStatusStatusCodeTimeout                    AuditLogsPresignedURLRequestStatusStatusCode = "TIMEOUT"
	AuditLogsPresignedURLRequestStatusStatusCodeExists                     AuditLogsPresignedURLRequestStatusStatusCode = "EXISTS"
	AuditLogsPresignedURLRequestStatusStatusCodeNotFound                   AuditLogsPresignedURLRequestStatusStatusCode = "NOT_FOUND"
	AuditLogsPresignedURLRequestStatusStatusCodeInternalError              AuditLogsPresignedURLRequestStatusStatusCode = "INTERNAL_ERROR"
	AuditLogsPresignedURLRequestStatusStatusCodeInvalidRequest             AuditLogsPresignedURLRequestStatusStatusCode = "INVALID_REQUEST"
	AuditLogsPresignedURLRequestStatusStatusCodeInvalidRequestVersion      AuditLogsPresignedURLRequestStatusStatusCode = "INVALID_REQUEST_VERSION"
	AuditLogsPresignedURLRequestStatusStatusCodeInvalidRequestData         AuditLogsPresignedURLRequestStatusStatusCode = "INVALID_REQUEST_DATA"
	AuditLogsPresignedURLRequestStatusStatusCodeMethodNotAllowed           AuditLogsPresignedURLRequestStatusStatusCode = "METHOD_NOT_ALLOWED"
	AuditLogsPresignedURLRequestStatusStatusCodeConflict                   AuditLogsPresignedURLRequestStatusStatusCode = "CONFLICT"
	AuditLogsPresignedURLRequestStatusStatusCodeUnprocessableEntity        AuditLogsPresignedURLRequestStatusStatusCode = "UNPROCESSABLE_ENTITY"
	AuditLogsPresignedURLRequestStatusStatusCodeTooManyRequests            AuditLogsPresignedURLRequestStatusStatusCode = "TOO_MANY_REQUESTS"
	AuditLogsPresignedURLRequestStatusStatusCodeInsufficientStorage        AuditLogsPresignedURLRequestStatusStatusCode = "INSUFFICIENT_STORAGE"
	AuditLogsPresignedURLRequestStatusStatusCodeServiceUnavailable         AuditLogsPresignedURLRequestStatusStatusCode = "SERVICE_UNAVAILABLE"
	AuditLogsPresignedURLRequestStatusStatusCodePayloadTooLarge            AuditLogsPresignedURLRequestStatusStatusCode = "PAYLOAD_TOO_LARGE"
	AuditLogsPresignedURLRequestStatusStatusCodeNotAcceptable              AuditLogsPresignedURLRequestStatusStatusCode = "NOT_ACCEPTABLE"
	AuditLogsPresignedURLRequestStatusStatusCodeUnavailableForLegalReasons AuditLogsPresignedURLRequestStatusStatusCode = "UNAVAILABLE_FOR_LEGAL_REASONS"
	AuditLogsPresignedURLRequestStatusStatusCodeBadGateway                 AuditLogsPresignedURLRequestStatusStatusCode = "BAD_GATEWAY"
)

func (AuditLogsPresignedURLRequestStatusStatusCode) IsKnown 

func (r AuditLogsPresignedURLRequestStatusStatusCode) IsKnown() bool

type AuditLogsResponse 

type AuditLogsResponse struct {
	// Array of auditLogs object
	AuditLogsList []AuditLogsResponseAuditLogsList `json:"auditLogsList"`
	RequestStatus AuditLogsResponseRequestStatus   `json:"requestStatus"`
	JSON          auditLogsResponseJSON            `json:"-"`
}

List of audit logs object

func (*AuditLogsResponse) UnmarshalJSON 

func (r *AuditLogsResponse) UnmarshalJSON(data []byte) (err error)

type AuditLogsResponseAuditLogsList 

type AuditLogsResponseAuditLogsList struct {
	// Audit logs from date
	AuditLogsFrom string `json:"auditLogsFrom"`
	// Unique Id of audit logs
	AuditLogsID string `json:"auditLogsId"`
	// Status of audit logs
	AuditLogsStatus AuditLogsResponseAuditLogsListAuditLogsStatus `json:"auditLogsStatus"`
	// Audit logs to date
	AuditLogsTo string `json:"auditLogsTo"`
	// Audit logs requested date
	RequestedDate string `json:"requestedDate"`
	// Audit logs requester email
	RequesterEmail string `json:"requesterEmail"`
	// Audit logs requester name
	RequesterName string `json:"requesterName"`
	// [DEPRECATED] Audit logs requester email
	RequsterEmail string `json:"requsterEmail"`
	// [DEPRECATED] Audit logs requester name
	RequsterName string                             `json:"requsterName"`
	JSON         auditLogsResponseAuditLogsListJSON `json:"-"`
}

Object of audit logs

func (*AuditLogsResponseAuditLogsList) UnmarshalJSON 

func (r *AuditLogsResponseAuditLogsList) UnmarshalJSON(data []byte) (err error)

type AuditLogsResponseAuditLogsListAuditLogsStatus 

type AuditLogsResponseAuditLogsListAuditLogsStatus string

Status of audit logs 

const (
	AuditLogsResponseAuditLogsListAuditLogsStatusUnknown   AuditLogsResponseAuditLogsListAuditLogsStatus = "UNKNOWN"
	AuditLogsResponseAuditLogsListAuditLogsStatusRequested AuditLogsResponseAuditLogsListAuditLogsStatus = "REQUESTED"
	AuditLogsResponseAuditLogsListAuditLogsStatusReady     AuditLogsResponseAuditLogsListAuditLogsStatus = "READY"
)

func (AuditLogsResponseAuditLogsListAuditLogsStatus) IsKnown 

func (r AuditLogsResponseAuditLogsListAuditLogsStatus) IsKnown() bool

type AuditLogsResponseRequestStatus 

type AuditLogsResponseRequestStatus struct {
	RequestID string `json:"requestId"`
	ServerID  string `json:"serverId"`
	// Describes response status reported by the server.
	StatusCode        AuditLogsResponseRequestStatusStatusCode `json:"statusCode"`
	StatusDescription string                                   `json:"statusDescription"`
	JSON              auditLogsResponseRequestStatusJSON       `json:"-"`
}

func (*AuditLogsResponseRequestStatus) UnmarshalJSON 

func (r *AuditLogsResponseRequestStatus) UnmarshalJSON(data []byte) (err error)

type AuditLogsResponseRequestStatusStatusCode 

type AuditLogsResponseRequestStatusStatusCode string

Describes response status reported by the server. 

const (
	AuditLogsResponseRequestStatusStatusCodeUnknown                    AuditLogsResponseRequestStatusStatusCode = "UNKNOWN"
	AuditLogsResponseRequestStatusStatusCodeSuccess                    AuditLogsResponseRequestStatusStatusCode = "SUCCESS"
	AuditLogsResponseRequestStatusStatusCodeUnauthorized               AuditLogsResponseRequestStatusStatusCode = "UNAUTHORIZED"
	AuditLogsResponseRequestStatusStatusCodePaymentRequired            AuditLogsResponseRequestStatusStatusCode = "PAYMENT_REQUIRED"
	AuditLogsResponseRequestStatusStatusCodeForbidden                  AuditLogsResponseRequestStatusStatusCode = "FORBIDDEN"
	AuditLogsResponseRequestStatusStatusCodeTimeout                    AuditLogsResponseRequestStatusStatusCode = "TIMEOUT"
	AuditLogsResponseRequestStatusStatusCodeExists                     AuditLogsResponseRequestStatusStatusCode = "EXISTS"
	AuditLogsResponseRequestStatusStatusCodeNotFound                   AuditLogsResponseRequestStatusStatusCode = "NOT_FOUND"
	AuditLogsResponseRequestStatusStatusCodeInternalError              AuditLogsResponseRequestStatusStatusCode = "INTERNAL_ERROR"
	AuditLogsResponseRequestStatusStatusCodeInvalidRequest             AuditLogsResponseRequestStatusStatusCode = "INVALID_REQUEST"
	AuditLogsResponseRequestStatusStatusCodeInvalidRequestVersion      AuditLogsResponseRequestStatusStatusCode = "INVALID_REQUEST_VERSION"
	AuditLogsResponseRequestStatusStatusCodeInvalidRequestData         AuditLogsResponseRequestStatusStatusCode = "INVALID_REQUEST_DATA"
	AuditLogsResponseRequestStatusStatusCodeMethodNotAllowed           AuditLogsResponseRequestStatusStatusCode = "METHOD_NOT_ALLOWED"
	AuditLogsResponseRequestStatusStatusCodeConflict                   AuditLogsResponseRequestStatusStatusCode = "CONFLICT"
	AuditLogsResponseRequestStatusStatusCodeUnprocessableEntity        AuditLogsResponseRequestStatusStatusCode = "UNPROCESSABLE_ENTITY"
	AuditLogsResponseRequestStatusStatusCodeTooManyRequests            AuditLogsResponseRequestStatusStatusCode = "TOO_MANY_REQUESTS"
	AuditLogsResponseRequestStatusStatusCodeInsufficientStorage        AuditLogsResponseRequestStatusStatusCode = "INSUFFICIENT_STORAGE"
	AuditLogsResponseRequestStatusStatusCodeServiceUnavailable         AuditLogsResponseRequestStatusStatusCode = "SERVICE_UNAVAILABLE"
	AuditLogsResponseRequestStatusStatusCodePayloadTooLarge            AuditLogsResponseRequestStatusStatusCode = "PAYLOAD_TOO_LARGE"
	AuditLogsResponseRequestStatusStatusCodeNotAcceptable              AuditLogsResponseRequestStatusStatusCode = "NOT_ACCEPTABLE"
	AuditLogsResponseRequestStatusStatusCodeUnavailableForLegalReasons AuditLogsResponseRequestStatusStatusCode = "UNAVAILABLE_FOR_LEGAL_REASONS"
	AuditLogsResponseRequestStatusStatusCodeBadGateway                 AuditLogsResponseRequestStatusStatusCode = "BAD_GATEWAY"
)

func (AuditLogsResponseRequestStatusStatusCode) IsKnown 

func (r AuditLogsResponseRequestStatusStatusCode) IsKnown() bool

type Client 

type Client struct {
	Options                  []option.RequestOption
	Orgs                     *OrgService
	Admin                    *AdminService
	Users                    *UserService
	Organizations            *OrganizationService
	SuperAdminUser           *SuperAdminUserService
	SuperAdminOrg            *SuperAdminOrgService
	SuperAdminOrgControllers *SuperAdminOrgControllerService
	UsersManagement          *UsersManagementService
	Org                      *OrgService
	V2AdminOrgUsers          *V2AdminOrgUserService
	V2AdminOrgTeams          *V2AdminOrgTeamService
	V2AdminOrgTeamUsers      *V2AdminOrgTeamUserService
	V2AdminOrgEntitlements   *V2AdminOrgEntitlementService
	V2AdminEntitlements      *V2AdminEntitlementService
	Services                 *ServiceService
	V3OrgsUsers              *V3OrgsUserService
	V3OrgsTeamsUsers         *V3OrgsTeamsUserService
	V3Orgs                   *V3OrgService
	Roles                    *RoleService
	PublicKeys               *PublicKeyService
	Health                   *HealthService
	SwaggerResources         *SwaggerResourceService
}

Client creates a struct with services and top level methods that help with interacting with the ngc API. You should not instantiate this client directly, and instead use the NewClient method instead.

func NewClient 

func NewClient(opts ...option.RequestOption) (r *Client)

NewClient generates a new client with the default option read from the environment (NVCF_AUTH_TOKEN). The option passed in as arguments are applied after these default arguments, and all option will be passed down to the services and requests that this client makes.

func (*Client) Delete 

func (r *Client) Delete(ctx context.Context, path string, params interface{}, res interface{}, opts ...option.RequestOption) error

Delete makes a DELETE request with the given URL, params, and optionally deserializes to a response. See [Execute] documentation on the params and response.

func (*Client) Execute 

func (r *Client) Execute(ctx context.Context, method string, path string, params interface{}, res interface{}, opts ...option.RequestOption) error

Execute makes a request with the given context, method, URL, request params, response, and request options. This is useful for hitting undocumented endpoints while retaining the base URL, auth, retries, and other options from the client.

If a byte slice or an io.Reader is supplied to params, it will be used as-is for the request body.

The params is by default serialized into the body using encoding/json. If your type implements a MarshalJSON function, it will be used instead to serialize the request. If a URLQuery method is implemented, the returned url.Values will be used as query strings to the url.

If your params struct uses param.Field, you must provide either [MarshalJSON], [URLQuery], and/or [MarshalForm] functions. It is undefined behavior to use a struct uses param.Field without specifying how it is serialized.

Any "…Params" object defined in this library can be used as the request argument. Note that 'path' arguments will not be forwarded into the url.

The response body will be deserialized into the res variable, depending on its type:

  • A pointer to a *http.Response is populated by the raw response.
  • A pointer to a byte array will be populated with the contents of the request body.
  • A pointer to any other type uses this library's default JSON decoding, which respects UnmarshalJSON if it is defined on the type.
  • A nil value will not read the response body.

For even greater flexibility, see option.WithResponseInto and option.WithResponseBodyInto.

func (*Client) Get 

func (r *Client) Get(ctx context.Context, path string, params interface{}, res interface{}, opts ...option.RequestOption) error

Get makes a GET request with the given URL, params, and optionally deserializes to a response. See [Execute] documentation on the params and response.

func (*Client) Patch 

func (r *Client) Patch(ctx context.Context, path string, params interface{}, res interface{}, opts ...option.RequestOption) error

Patch makes a PATCH request with the given URL, params, and optionally deserializes to a response. See [Execute] documentation on the params and response.

func (*Client) Post 

func (r *Client) Post(ctx context.Context, path string, params interface{}, res interface{}, opts ...option.RequestOption) error

Post makes a POST request with the given URL, params, and optionally deserializes to a response. See [Execute] documentation on the params and response.

func (*Client) Put 

func (r *Client) Put(ctx context.Context, path string, params interface{}, res interface{}, opts ...option.RequestOption) error

Put makes a PUT request with the given URL, params, and optionally deserializes to a response. See [Execute] documentation on the params and response.

type CreditsHistory 

type CreditsHistory struct {
	CreditsHistory CreditsHistoryCreditsHistory `json:"creditsHistory"`
	RequestStatus  CreditsHistoryRequestStatus  `json:"requestStatus"`
	JSON           creditsHistoryJSON           `json:"-"`
}

showing credit balance

func (*CreditsHistory) UnmarshalJSON 

func (r *CreditsHistory) UnmarshalJSON(data []byte) (err error)

type CreditsHistoryCreditsHistory 

type CreditsHistoryCreditsHistory struct {
	// Latest credit balance information
	CreditBalance int64                            `json:"creditBalance"`
	JSON          creditsHistoryCreditsHistoryJSON `json:"-"`
}

func (*CreditsHistoryCreditsHistory) UnmarshalJSON 

func (r *CreditsHistoryCreditsHistory) UnmarshalJSON(data []byte) (err error)

type CreditsHistoryRequestStatus 

type CreditsHistoryRequestStatus struct {
	RequestID string `json:"requestId"`
	ServerID  string `json:"serverId"`
	// Describes response status reported by the server.
	StatusCode        CreditsHistoryRequestStatusStatusCode `json:"statusCode"`
	StatusDescription string                                `json:"statusDescription"`
	JSON              creditsHistoryRequestStatusJSON       `json:"-"`
}

func (*CreditsHistoryRequestStatus) UnmarshalJSON 

func (r *CreditsHistoryRequestStatus) UnmarshalJSON(data []byte) (err error)

type CreditsHistoryRequestStatusStatusCode 

type CreditsHistoryRequestStatusStatusCode string

Describes response status reported by the server. 

const (
	CreditsHistoryRequestStatusStatusCodeUnknown                    CreditsHistoryRequestStatusStatusCode = "UNKNOWN"
	CreditsHistoryRequestStatusStatusCodeSuccess                    CreditsHistoryRequestStatusStatusCode = "SUCCESS"
	CreditsHistoryRequestStatusStatusCodeUnauthorized               CreditsHistoryRequestStatusStatusCode = "UNAUTHORIZED"
	CreditsHistoryRequestStatusStatusCodePaymentRequired            CreditsHistoryRequestStatusStatusCode = "PAYMENT_REQUIRED"
	CreditsHistoryRequestStatusStatusCodeForbidden                  CreditsHistoryRequestStatusStatusCode = "FORBIDDEN"
	CreditsHistoryRequestStatusStatusCodeTimeout                    CreditsHistoryRequestStatusStatusCode = "TIMEOUT"
	CreditsHistoryRequestStatusStatusCodeExists                     CreditsHistoryRequestStatusStatusCode = "EXISTS"
	CreditsHistoryRequestStatusStatusCodeNotFound                   CreditsHistoryRequestStatusStatusCode = "NOT_FOUND"
	CreditsHistoryRequestStatusStatusCodeInternalError              CreditsHistoryRequestStatusStatusCode = "INTERNAL_ERROR"
	CreditsHistoryRequestStatusStatusCodeInvalidRequest             CreditsHistoryRequestStatusStatusCode = "INVALID_REQUEST"
	CreditsHistoryRequestStatusStatusCodeInvalidRequestVersion      CreditsHistoryRequestStatusStatusCode = "INVALID_REQUEST_VERSION"
	CreditsHistoryRequestStatusStatusCodeInvalidRequestData         CreditsHistoryRequestStatusStatusCode = "INVALID_REQUEST_DATA"
	CreditsHistoryRequestStatusStatusCodeMethodNotAllowed           CreditsHistoryRequestStatusStatusCode = "METHOD_NOT_ALLOWED"
	CreditsHistoryRequestStatusStatusCodeConflict                   CreditsHistoryRequestStatusStatusCode = "CONFLICT"
	CreditsHistoryRequestStatusStatusCodeUnprocessableEntity        CreditsHistoryRequestStatusStatusCode = "UNPROCESSABLE_ENTITY"
	CreditsHistoryRequestStatusStatusCodeTooManyRequests            CreditsHistoryRequestStatusStatusCode = "TOO_MANY_REQUESTS"
	CreditsHistoryRequestStatusStatusCodeInsufficientStorage        CreditsHistoryRequestStatusStatusCode = "INSUFFICIENT_STORAGE"
	CreditsHistoryRequestStatusStatusCodeServiceUnavailable         CreditsHistoryRequestStatusStatusCode = "SERVICE_UNAVAILABLE"
	CreditsHistoryRequestStatusStatusCodePayloadTooLarge            CreditsHistoryRequestStatusStatusCode = "PAYLOAD_TOO_LARGE"
	CreditsHistoryRequestStatusStatusCodeNotAcceptable              CreditsHistoryRequestStatusStatusCode = "NOT_ACCEPTABLE"
	CreditsHistoryRequestStatusStatusCodeUnavailableForLegalReasons CreditsHistoryRequestStatusStatusCode = "UNAVAILABLE_FOR_LEGAL_REASONS"
	CreditsHistoryRequestStatusStatusCodeBadGateway                 CreditsHistoryRequestStatusStatusCode = "BAD_GATEWAY"
)

func (CreditsHistoryRequestStatusStatusCode) IsKnown 

func (r CreditsHistoryRequestStatusStatusCode) IsKnown() bool

type Error 

type Error = apierror.Error

type Health 

type Health = shared.Health

This API is invoked by monitoring tools, other services and infrastructure to retrieve health status the targeted service, this is unprotected method

This is an alias to an internal type.

type HealthAllGetAllParams 

type HealthAllGetAllParams struct {
	// secret value that validates the call in order to show details
	Secret param.Field[string] `query:"secret"`
	// boolean value to indicating to show details or not
	ShowDetails param.Field[bool] `query:"showDetails"`
}

func (HealthAllGetAllParams) URLQuery 

func (r HealthAllGetAllParams) URLQuery() (v url.Values)

URLQuery serializes HealthAllGetAllParams's query parameters as `url.Values`.

type HealthAllService 

type HealthAllService struct {
	Options []option.RequestOption
}

HealthAllService contains methods and other services that help with interacting with the ngc API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewHealthAllService method instead.

func NewHealthAllService 

func NewHealthAllService(opts ...option.RequestOption) (r *HealthAllService)

NewHealthAllService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*HealthAllService) GetAll 

func (r *HealthAllService) GetAll(ctx context.Context, query HealthAllGetAllParams, opts ...option.RequestOption) (res *shared.Health, err error)

Used to get health status of all services

type HealthHealth 

type HealthHealth = shared.HealthHealth

object that describes health of the service

This is an alias to an internal type.

type HealthHealthHealthCode 

type HealthHealthHealthCode = shared.HealthHealthHealthCode

Enum that describes health of the service

This is an alias to an internal type.

type HealthHealthMetaData 

type HealthHealthMetaData = shared.HealthHealthMetaData

This is an alias to an internal type.

type HealthRequestStatus 

type HealthRequestStatus = shared.HealthRequestStatus

This is an alias to an internal type.

type HealthRequestStatusStatusCode 

type HealthRequestStatusStatusCode = shared.HealthRequestStatusStatusCode

Describes response status reported by the server.

This is an alias to an internal type.

type HealthService 

type HealthService struct {
	Options []option.RequestOption
	All     *HealthAllService
}

HealthService contains methods and other services that help with interacting with the ngc API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewHealthService method instead.

func NewHealthService 

func NewHealthService(opts ...option.RequestOption) (r *HealthService)

NewHealthService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*HealthService) GetAll 

func (r *HealthService) GetAll(ctx context.Context, opts ...option.RequestOption) (res *shared.Health, err error)

Used to check the health status of the web service only

type MeteringResultList 

type MeteringResultList = shared.MeteringResultList

response containing a list of all metering queries results

This is an alias to an internal type.

type MeteringResultListMeasurement 

type MeteringResultListMeasurement = shared.MeteringResultListMeasurement

result of a single measurement query

This is an alias to an internal type.

type MeteringResultListMeasurementsSeriesTag 

type MeteringResultListMeasurementsSeriesTag = shared.MeteringResultListMeasurementsSeriesTag

object for measurement tags which identifies a measuurement series

This is an alias to an internal type.

type MeteringResultListMeasurementsSeriesValue 

type MeteringResultListMeasurementsSeriesValue = shared.MeteringResultListMeasurementsSeriesValue

object for the measurement values

This is an alias to an internal type.

type MeteringResultListMeasurementsSery 

type MeteringResultListMeasurementsSery = shared.MeteringResultListMeasurementsSery

object for a single series in the measurement

This is an alias to an internal type.

type MeteringResultListRequestStatus 

type MeteringResultListRequestStatus = shared.MeteringResultListRequestStatus

This is an alias to an internal type.

type MeteringResultListRequestStatusStatusCode 

type MeteringResultListRequestStatusStatusCode = shared.MeteringResultListRequestStatusStatusCode

Describes response status reported by the server.

This is an alias to an internal type.

type OrgAuditLogService 

type OrgAuditLogService struct {
	Options []option.RequestOption
}

OrgAuditLogService contains methods and other services that help with interacting with the ngc API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewOrgAuditLogService method instead.

func NewOrgAuditLogService 

func NewOrgAuditLogService(opts ...option.RequestOption) (r *OrgAuditLogService)

NewOrgAuditLogService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*OrgAuditLogService) Get 

func (r *OrgAuditLogService) Get(ctx context.Context, orgName string, logID string, opts ...option.RequestOption) (res *AuditLogsPresignedURL, err error)

Get downloable link for audit logs

type OrgCreditService 

type OrgCreditService struct {
	Options []option.RequestOption
}

OrgCreditService contains methods and other services that help with interacting with the ngc API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewOrgCreditService method instead.

func NewOrgCreditService 

func NewOrgCreditService(opts ...option.RequestOption) (r *OrgCreditService)

NewOrgCreditService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*OrgCreditService) Get 

func (r *OrgCreditService) Get(ctx context.Context, orgName string, opts ...option.RequestOption) (res *CreditsHistory, err error)

Get Organization credits

type OrgInvitation 

type OrgInvitation struct {
	// Org invitation to NGC
	OrgInvitation OrgInvitationOrgInvitation `json:"orgInvitation"`
	RequestStatus OrgInvitationRequestStatus `json:"requestStatus"`
	JSON          orgInvitationJSON          `json:"-"`
}

Invitation Validation Response.

func (*OrgInvitation) UnmarshalJSON 

func (r *OrgInvitation) UnmarshalJSON(data []byte) (err error)

type OrgInvitationOrgInvitation 

type OrgInvitationOrgInvitation struct {
	// Email address of the user.
	Email string `json:"email"`
	// Proto Org identifier.
	ProtoOrgID string                         `json:"protoOrgId"`
	JSON       orgInvitationOrgInvitationJSON `json:"-"`
}

Org invitation to NGC

func (*OrgInvitationOrgInvitation) UnmarshalJSON 

func (r *OrgInvitationOrgInvitation) UnmarshalJSON(data []byte) (err error)

type OrgInvitationRequestStatus 

type OrgInvitationRequestStatus struct {
	RequestID string `json:"requestId"`
	ServerID  string `json:"serverId"`
	// Describes response status reported by the server.
	StatusCode        OrgInvitationRequestStatusStatusCode `json:"statusCode"`
	StatusDescription string                               `json:"statusDescription"`
	JSON              orgInvitationRequestStatusJSON       `json:"-"`
}

func (*OrgInvitationRequestStatus) UnmarshalJSON 

func (r *OrgInvitationRequestStatus) UnmarshalJSON(data []byte) (err error)

type OrgInvitationRequestStatusStatusCode 

type OrgInvitationRequestStatusStatusCode string

Describes response status reported by the server. 

const (
	OrgInvitationRequestStatusStatusCodeUnknown                    OrgInvitationRequestStatusStatusCode = "UNKNOWN"
	OrgInvitationRequestStatusStatusCodeSuccess                    OrgInvitationRequestStatusStatusCode = "SUCCESS"
	OrgInvitationRequestStatusStatusCodeUnauthorized               OrgInvitationRequestStatusStatusCode = "UNAUTHORIZED"
	OrgInvitationRequestStatusStatusCodePaymentRequired            OrgInvitationRequestStatusStatusCode = "PAYMENT_REQUIRED"
	OrgInvitationRequestStatusStatusCodeForbidden                  OrgInvitationRequestStatusStatusCode = "FORBIDDEN"
	OrgInvitationRequestStatusStatusCodeTimeout                    OrgInvitationRequestStatusStatusCode = "TIMEOUT"
	OrgInvitationRequestStatusStatusCodeExists                     OrgInvitationRequestStatusStatusCode = "EXISTS"
	OrgInvitationRequestStatusStatusCodeNotFound                   OrgInvitationRequestStatusStatusCode = "NOT_FOUND"
	OrgInvitationRequestStatusStatusCodeInternalError              OrgInvitationRequestStatusStatusCode = "INTERNAL_ERROR"
	OrgInvitationRequestStatusStatusCodeInvalidRequest             OrgInvitationRequestStatusStatusCode = "INVALID_REQUEST"
	OrgInvitationRequestStatusStatusCodeInvalidRequestVersion      OrgInvitationRequestStatusStatusCode = "INVALID_REQUEST_VERSION"
	OrgInvitationRequestStatusStatusCodeInvalidRequestData         OrgInvitationRequestStatusStatusCode = "INVALID_REQUEST_DATA"
	OrgInvitationRequestStatusStatusCodeMethodNotAllowed           OrgInvitationRequestStatusStatusCode = "METHOD_NOT_ALLOWED"
	OrgInvitationRequestStatusStatusCodeConflict                   OrgInvitationRequestStatusStatusCode = "CONFLICT"
	OrgInvitationRequestStatusStatusCodeUnprocessableEntity        OrgInvitationRequestStatusStatusCode = "UNPROCESSABLE_ENTITY"
	OrgInvitationRequestStatusStatusCodeTooManyRequests            OrgInvitationRequestStatusStatusCode = "TOO_MANY_REQUESTS"
	OrgInvitationRequestStatusStatusCodeInsufficientStorage        OrgInvitationRequestStatusStatusCode = "INSUFFICIENT_STORAGE"
	OrgInvitationRequestStatusStatusCodeServiceUnavailable         OrgInvitationRequestStatusStatusCode = "SERVICE_UNAVAILABLE"
	OrgInvitationRequestStatusStatusCodePayloadTooLarge            OrgInvitationRequestStatusStatusCode = "PAYLOAD_TOO_LARGE"
	OrgInvitationRequestStatusStatusCodeNotAcceptable              OrgInvitationRequestStatusStatusCode = "NOT_ACCEPTABLE"
	OrgInvitationRequestStatusStatusCodeUnavailableForLegalReasons OrgInvitationRequestStatusStatusCode = "UNAVAILABLE_FOR_LEGAL_REASONS"
	OrgInvitationRequestStatusStatusCodeBadGateway                 OrgInvitationRequestStatusStatusCode = "BAD_GATEWAY"
)

func (OrgInvitationRequestStatusStatusCode) IsKnown 

func (r OrgInvitationRequestStatusStatusCode) IsKnown() bool

type OrgList 

type OrgList struct {
	Organizations []OrgListOrganization `json:"organizations"`
	// object that describes the pagination information
	PaginationInfo OrgListPaginationInfo `json:"paginationInfo"`
	RequestStatus  OrgListRequestStatus  `json:"requestStatus"`
	JSON           orgListJSON           `json:"-"`
}

List of organizations.

func (*OrgList) UnmarshalJSON 

func (r *OrgList) UnmarshalJSON(data []byte) (err error)

type OrgListOrganization 

type OrgListOrganization struct {
	// Unique Id of this team.
	ID int64 `json:"id"`
	// Org Owner Alternate Contact
	AlternateContact OrgListOrganizationsAlternateContact `json:"alternateContact"`
	// Billing account ID.
	BillingAccountID string `json:"billingAccountId"`
	// Identifies if the org can be reused.
	CanAddOn bool `json:"canAddOn"`
	// ISO country code of the organization.
	Country string `json:"country"`
	// Optional description of the organization.
	Description string `json:"description"`
	// Name of the organization that will be shown to users.
	DisplayName string `json:"displayName"`
	// Identity Provider ID.
	IdpID string `json:"idpId"`
	// Industry of the organization.
	Industry string `json:"industry"`
	// Infinity manager setting definition
	InfinityManagerSettings OrgListOrganizationsInfinityManagerSettings `json:"infinityManagerSettings"`
	// Dataset Service enable flag for an organization
	IsDatasetServiceEnabled bool `json:"isDatasetServiceEnabled"`
	// Is NVIDIA internal org or not
	IsInternal bool `json:"isInternal"`
	// Indicates when the org is a proto org
	IsProto bool `json:"isProto"`
	// Quick Start enable flag for an organization
	IsQuickStartEnabled bool `json:"isQuickStartEnabled"`
	// If a server side encryption is enabled for private registry (models, resources)
	IsRegistrySseEnabled bool `json:"isRegistrySSEEnabled"`
	// Secrets Manager Service enable flag for an organization
	IsSecretsManagerServiceEnabled bool `json:"isSecretsManagerServiceEnabled"`
	// Secure Credential Sharing Service enable flag for an organization
	IsSecureCredentialSharingServiceEnabled bool `json:"isSecureCredentialSharingServiceEnabled"`
	// If a separate influx db used for an organization in BCP for job telemetry
	IsSeparateInfluxDBUsed bool `json:"isSeparateInfluxDbUsed"`
	// Organization name.
	Name string `json:"name"`
	// NVIDIA Cloud Account Number.
	Nan string `json:"nan"`
	// Org owner.
	OrgOwner OrgListOrganizationsOrgOwner `json:"orgOwner"`
	// Org owners
	OrgOwners []OrgListOrganizationsOrgOwner `json:"orgOwners"`
	// Product end customer salesforce.com Id (external customer Id). pecSfdcId is for
	// EMS (entitlement management service) to track external paid customer.
	PecSfdcID            string                                    `json:"pecSfdcId"`
	ProductEnablements   []OrgListOrganizationsProductEnablement   `json:"productEnablements"`
	ProductSubscriptions []OrgListOrganizationsProductSubscription `json:"productSubscriptions"`
	// Repo scan setting definition
	RepoScanSettings OrgListOrganizationsRepoScanSettings `json:"repoScanSettings"`
	Type             OrgListOrganizationsType             `json:"type"`
	// Users information.
	UsersInfo OrgListOrganizationsUsersInfo `json:"usersInfo"`
	JSON      orgListOrganizationJSON       `json:"-"`
}

Information about the Organization

func (*OrgListOrganization) UnmarshalJSON 

func (r *OrgListOrganization) UnmarshalJSON(data []byte) (err error)

type OrgListOrganizationsAlternateContact 

type OrgListOrganizationsAlternateContact struct {
	// Alternate contact's email.
	Email string `json:"email"`
	// Full name of the alternate contact.
	FullName string                                   `json:"fullName"`
	JSON     orgListOrganizationsAlternateContactJSON `json:"-"`
}

Org Owner Alternate Contact

func (*OrgListOrganizationsAlternateContact) UnmarshalJSON 

func (r *OrgListOrganizationsAlternateContact) UnmarshalJSON(data []byte) (err error)

type OrgListOrganizationsInfinityManagerSettings 

type OrgListOrganizationsInfinityManagerSettings struct {
	// Enable the infinity manager or not. Used both in org and team level object
	InfinityManagerEnabled bool `json:"infinityManagerEnabled"`
	// Allow override settings at team level. Only used in org level object
	InfinityManagerEnableTeamOverride bool                                            `json:"infinityManagerEnableTeamOverride"`
	JSON                              orgListOrganizationsInfinityManagerSettingsJSON `json:"-"`
}

Infinity manager setting definition

func (*OrgListOrganizationsInfinityManagerSettings) UnmarshalJSON 

func (r *OrgListOrganizationsInfinityManagerSettings) UnmarshalJSON(data []byte) (err error)

type OrgListOrganizationsOrgOwner 

type OrgListOrganizationsOrgOwner struct {
	// Email address of the org owner.
	Email string `json:"email,required"`
	// Org owner name.
	FullName string `json:"fullName,required"`
	// Last time the org owner logged in.
	LastLoginDate string                           `json:"lastLoginDate"`
	JSON          orgListOrganizationsOrgOwnerJSON `json:"-"`
}

Org owner.

func (*OrgListOrganizationsOrgOwner) UnmarshalJSON 

func (r *OrgListOrganizationsOrgOwner) UnmarshalJSON(data []byte) (err error)

type OrgListOrganizationsProductEnablement 

type OrgListOrganizationsProductEnablement struct {
	// Product Name (NVAIE, BASE_COMMAND, REGISTRY, etc)
	ProductName string `json:"productName,required"`
	// Product Enablement Types
	Type OrgListOrganizationsProductEnablementsType `json:"type,required"`
	// Date on which the subscription expires. The subscription is invalid after this
	// date. (yyyy-MM-dd)
	ExpirationDate string                                           `json:"expirationDate"`
	PoDetails      []OrgListOrganizationsProductEnablementsPoDetail `json:"poDetails"`
	JSON           orgListOrganizationsProductEnablementJSON        `json:"-"`
}

Product Enablement

func (*OrgListOrganizationsProductEnablement) UnmarshalJSON 

func (r *OrgListOrganizationsProductEnablement) UnmarshalJSON(data []byte) (err error)

type OrgListOrganizationsProductEnablementsPoDetail 

type OrgListOrganizationsProductEnablementsPoDetail struct {
	// Entitlement identifier.
	EntitlementID string `json:"entitlementId"`
	// PAK (Product Activation Key) identifier.
	PkID string                                             `json:"pkId"`
	JSON orgListOrganizationsProductEnablementsPoDetailJSON `json:"-"`
}

Purchase Order.

func (*OrgListOrganizationsProductEnablementsPoDetail) UnmarshalJSON 

func (r *OrgListOrganizationsProductEnablementsPoDetail) UnmarshalJSON(data []byte) (err error)

type OrgListOrganizationsProductEnablementsType 

type OrgListOrganizationsProductEnablementsType string

Product Enablement Types 

const (
	OrgListOrganizationsProductEnablementsTypeNgcAdminEval       OrgListOrganizationsProductEnablementsType = "NGC_ADMIN_EVAL"
	OrgListOrganizationsProductEnablementsTypeNgcAdminNfr        OrgListOrganizationsProductEnablementsType = "NGC_ADMIN_NFR"
	OrgListOrganizationsProductEnablementsTypeNgcAdminCommercial OrgListOrganizationsProductEnablementsType = "NGC_ADMIN_COMMERCIAL"
	OrgListOrganizationsProductEnablementsTypeEmsEval            OrgListOrganizationsProductEnablementsType = "EMS_EVAL"
	OrgListOrganizationsProductEnablementsTypeEmsNfr             OrgListOrganizationsProductEnablementsType = "EMS_NFR"
	OrgListOrganizationsProductEnablementsTypeEmsCommercial      OrgListOrganizationsProductEnablementsType = "EMS_COMMERCIAL"
	OrgListOrganizationsProductEnablementsTypeNgcAdminDeveloper  OrgListOrganizationsProductEnablementsType = "NGC_ADMIN_DEVELOPER"
)

func (OrgListOrganizationsProductEnablementsType) IsKnown 

func (r OrgListOrganizationsProductEnablementsType) IsKnown() bool

type OrgListOrganizationsProductSubscription 

type OrgListOrganizationsProductSubscription struct {
	// Product Name (NVAIE, BASE_COMMAND, FleetCommand, REGISTRY, etc).
	ProductName string `json:"productName,required"`
	// Unique entitlement identifier
	ID string `json:"id"`
	// EMS Subscription type. (options: EMS_EVAL, EMS_NFR and EMS_COMMERCIAL)
	EmsEntitlementType OrgListOrganizationsProductSubscriptionsEmsEntitlementType `json:"emsEntitlementType"`
	// Date on which the subscription expires. The subscription is invalid after this
	// date. (yyyy-MM-dd)
	ExpirationDate string `json:"expirationDate"`
	// Date on which the subscription becomes active. (yyyy-MM-dd)
	StartDate string `json:"startDate"`
	// Subscription type. (options: NGC_ADMIN_EVAL, NGC_ADMIN_NFR,
	// NGC_ADMIN_COMMERCIAL)
	Type OrgListOrganizationsProductSubscriptionsType `json:"type"`
	JSON orgListOrganizationsProductSubscriptionJSON  `json:"-"`
}

Product Subscription

func (*OrgListOrganizationsProductSubscription) UnmarshalJSON 

func (r *OrgListOrganizationsProductSubscription) UnmarshalJSON(data []byte) (err error)

type OrgListOrganizationsProductSubscriptionsEmsEntitlementType 

type OrgListOrganizationsProductSubscriptionsEmsEntitlementType string

EMS Subscription type. (options: EMS_EVAL, EMS_NFR and EMS_COMMERCIAL) 

const (
	OrgListOrganizationsProductSubscriptionsEmsEntitlementTypeEmsEval       OrgListOrganizationsProductSubscriptionsEmsEntitlementType = "EMS_EVAL"
	OrgListOrganizationsProductSubscriptionsEmsEntitlementTypeEmsNfr        OrgListOrganizationsProductSubscriptionsEmsEntitlementType = "EMS_NFR"
	OrgListOrganizationsProductSubscriptionsEmsEntitlementTypeEmsCommerical OrgListOrganizationsProductSubscriptionsEmsEntitlementType = "EMS_COMMERICAL"
	OrgListOrganizationsProductSubscriptionsEmsEntitlementTypeEmsCommercial OrgListOrganizationsProductSubscriptionsEmsEntitlementType = "EMS_COMMERCIAL"
)

func (OrgListOrganizationsProductSubscriptionsEmsEntitlementType) IsKnown 

func (r OrgListOrganizationsProductSubscriptionsEmsEntitlementType) IsKnown() bool

type OrgListOrganizationsProductSubscriptionsType 

type OrgListOrganizationsProductSubscriptionsType string

Subscription type. (options: NGC_ADMIN_EVAL, NGC_ADMIN_NFR, NGC_ADMIN_COMMERCIAL) 

const (
	OrgListOrganizationsProductSubscriptionsTypeNgcAdminEval       OrgListOrganizationsProductSubscriptionsType = "NGC_ADMIN_EVAL"
	OrgListOrganizationsProductSubscriptionsTypeNgcAdminNfr        OrgListOrganizationsProductSubscriptionsType = "NGC_ADMIN_NFR"
	OrgListOrganizationsProductSubscriptionsTypeNgcAdminCommercial OrgListOrganizationsProductSubscriptionsType = "NGC_ADMIN_COMMERCIAL"
)

func (OrgListOrganizationsProductSubscriptionsType) IsKnown 

func (r OrgListOrganizationsProductSubscriptionsType) IsKnown() bool

type OrgListOrganizationsRepoScanSettings 

type OrgListOrganizationsRepoScanSettings struct {
	// Allow org admin to override the org level repo scan settings
	RepoScanAllowOverride bool `json:"repoScanAllowOverride"`
	// Allow repository scanning by default
	RepoScanByDefault bool `json:"repoScanByDefault"`
	// Enable the repository scan or not. Only used in org level object
	RepoScanEnabled bool `json:"repoScanEnabled"`
	// Sends notification to end user after scanning is done
	RepoScanEnableNotifications bool `json:"repoScanEnableNotifications"`
	// Allow override settings at team level. Only used in org level object
	RepoScanEnableTeamOverride bool `json:"repoScanEnableTeamOverride"`
	// Allow showing scan results to CLI or UI
	RepoScanShowResults bool                                     `json:"repoScanShowResults"`
	JSON                orgListOrganizationsRepoScanSettingsJSON `json:"-"`
}

Repo scan setting definition

func (*OrgListOrganizationsRepoScanSettings) UnmarshalJSON 

func (r *OrgListOrganizationsRepoScanSettings) UnmarshalJSON(data []byte) (err error)

type OrgListOrganizationsType 

type OrgListOrganizationsType string
const (
	OrgListOrganizationsTypeUnknown    OrgListOrganizationsType = "UNKNOWN"
	OrgListOrganizationsTypeCloud      OrgListOrganizationsType = "CLOUD"
	OrgListOrganizationsTypeEnterprise OrgListOrganizationsType = "ENTERPRISE"
	OrgListOrganizationsTypeIndividual OrgListOrganizationsType = "INDIVIDUAL"
)

func (OrgListOrganizationsType) IsKnown 

func (r OrgListOrganizationsType) IsKnown() bool

type OrgListOrganizationsUsersInfo 

type OrgListOrganizationsUsersInfo struct {
	// Total number of users.
	TotalUsers int64                             `json:"totalUsers"`
	JSON       orgListOrganizationsUsersInfoJSON `json:"-"`
}

Users information.

func (*OrgListOrganizationsUsersInfo) UnmarshalJSON 

func (r *OrgListOrganizationsUsersInfo) UnmarshalJSON(data []byte) (err error)

type OrgListPaginationInfo 

type OrgListPaginationInfo struct {
	// Page index of results
	Index int64 `json:"index"`
	// Serialized pointer to the next results page. Should be used for fetching next
	// page. Can be empty
	NextPage string `json:"nextPage"`
	// Number of results in page
	Size int64 `json:"size"`
	// Total number of pages available
	TotalPages int64 `json:"totalPages"`
	// Total number of results available
	TotalResults int64                     `json:"totalResults"`
	JSON         orgListPaginationInfoJSON `json:"-"`
}

object that describes the pagination information

func (*OrgListPaginationInfo) UnmarshalJSON 

func (r *OrgListPaginationInfo) UnmarshalJSON(data []byte) (err error)

type OrgListParams 

type OrgListParams struct {
	FilterUsingOrgDisplayName param.Field[string] `query:"Filter using org display name"`
	FilterUsingOrgName        param.Field[string] `query:"Filter using org name"`
	FilterUsingOrgOwnerEmail  param.Field[string] `query:"Filter using org owner email"`
	FilterUsingOrgOwnerName   param.Field[string] `query:"Filter using org owner name"`
	FilterUsingPecID          param.Field[string] `query:"Filter using PEC ID"`
	// The page number of result
	PageNumber param.Field[int64] `query:"page-number"`
	// The page size of result
	PageSize param.Field[int64] `query:"page-size"`
}

func (OrgListParams) URLQuery 

func (r OrgListParams) URLQuery() (v url.Values)

URLQuery serializes OrgListParams's query parameters as `url.Values`.

type OrgListRequestStatus 

type OrgListRequestStatus struct {
	RequestID string `json:"requestId"`
	ServerID  string `json:"serverId"`
	// Describes response status reported by the server.
	StatusCode        OrgListRequestStatusStatusCode `json:"statusCode"`
	StatusDescription string                         `json:"statusDescription"`
	JSON              orgListRequestStatusJSON       `json:"-"`
}

func (*OrgListRequestStatus) UnmarshalJSON 

func (r *OrgListRequestStatus) UnmarshalJSON(data []byte) (err error)

type OrgListRequestStatusStatusCode 

type OrgListRequestStatusStatusCode string

Describes response status reported by the server. 

const (
	OrgListRequestStatusStatusCodeUnknown                    OrgListRequestStatusStatusCode = "UNKNOWN"
	OrgListRequestStatusStatusCodeSuccess                    OrgListRequestStatusStatusCode = "SUCCESS"
	OrgListRequestStatusStatusCodeUnauthorized               OrgListRequestStatusStatusCode = "UNAUTHORIZED"
	OrgListRequestStatusStatusCodePaymentRequired            OrgListRequestStatusStatusCode = "PAYMENT_REQUIRED"
	OrgListRequestStatusStatusCodeForbidden                  OrgListRequestStatusStatusCode = "FORBIDDEN"
	OrgListRequestStatusStatusCodeTimeout                    OrgListRequestStatusStatusCode = "TIMEOUT"
	OrgListRequestStatusStatusCodeExists                     OrgListRequestStatusStatusCode = "EXISTS"
	OrgListRequestStatusStatusCodeNotFound                   OrgListRequestStatusStatusCode = "NOT_FOUND"
	OrgListRequestStatusStatusCodeInternalError              OrgListRequestStatusStatusCode = "INTERNAL_ERROR"
	OrgListRequestStatusStatusCodeInvalidRequest             OrgListRequestStatusStatusCode = "INVALID_REQUEST"
	OrgListRequestStatusStatusCodeInvalidRequestVersion      OrgListRequestStatusStatusCode = "INVALID_REQUEST_VERSION"
	OrgListRequestStatusStatusCodeInvalidRequestData         OrgListRequestStatusStatusCode = "INVALID_REQUEST_DATA"
	OrgListRequestStatusStatusCodeMethodNotAllowed           OrgListRequestStatusStatusCode = "METHOD_NOT_ALLOWED"
	OrgListRequestStatusStatusCodeConflict                   OrgListRequestStatusStatusCode = "CONFLICT"
	OrgListRequestStatusStatusCodeUnprocessableEntity        OrgListRequestStatusStatusCode = "UNPROCESSABLE_ENTITY"
	OrgListRequestStatusStatusCodeTooManyRequests            OrgListRequestStatusStatusCode = "TOO_MANY_REQUESTS"
	OrgListRequestStatusStatusCodeInsufficientStorage        OrgListRequestStatusStatusCode = "INSUFFICIENT_STORAGE"
	OrgListRequestStatusStatusCodeServiceUnavailable         OrgListRequestStatusStatusCode = "SERVICE_UNAVAILABLE"
	OrgListRequestStatusStatusCodePayloadTooLarge            OrgListRequestStatusStatusCode = "PAYLOAD_TOO_LARGE"
	OrgListRequestStatusStatusCodeNotAcceptable              OrgListRequestStatusStatusCode = "NOT_ACCEPTABLE"
	OrgListRequestStatusStatusCodeUnavailableForLegalReasons OrgListRequestStatusStatusCode = "UNAVAILABLE_FOR_LEGAL_REASONS"
	OrgListRequestStatusStatusCodeBadGateway                 OrgListRequestStatusStatusCode = "BAD_GATEWAY"
)

func (OrgListRequestStatusStatusCode) IsKnown 

func (r OrgListRequestStatusStatusCode) IsKnown() bool

type OrgListResponse 

type OrgListResponse struct {
	// Unique Id of this team.
	ID int64 `json:"id"`
	// Org Owner Alternate Contact
	AlternateContact OrgListResponseAlternateContact `json:"alternateContact"`
	// Billing account ID.
	BillingAccountID string `json:"billingAccountId"`
	// Identifies if the org can be reused.
	CanAddOn bool `json:"canAddOn"`
	// ISO country code of the organization.
	Country string `json:"country"`
	// Optional description of the organization.
	Description string `json:"description"`
	// Name of the organization that will be shown to users.
	DisplayName string `json:"displayName"`
	// Identity Provider ID.
	IdpID string `json:"idpId"`
	// Industry of the organization.
	Industry string `json:"industry"`
	// Infinity manager setting definition
	InfinityManagerSettings OrgListResponseInfinityManagerSettings `json:"infinityManagerSettings"`
	// Dataset Service enable flag for an organization
	IsDatasetServiceEnabled bool `json:"isDatasetServiceEnabled"`
	// Is NVIDIA internal org or not
	IsInternal bool `json:"isInternal"`
	// Indicates when the org is a proto org
	IsProto bool `json:"isProto"`
	// Quick Start enable flag for an organization
	IsQuickStartEnabled bool `json:"isQuickStartEnabled"`
	// If a server side encryption is enabled for private registry (models, resources)
	IsRegistrySseEnabled bool `json:"isRegistrySSEEnabled"`
	// Secrets Manager Service enable flag for an organization
	IsSecretsManagerServiceEnabled bool `json:"isSecretsManagerServiceEnabled"`
	// Secure Credential Sharing Service enable flag for an organization
	IsSecureCredentialSharingServiceEnabled bool `json:"isSecureCredentialSharingServiceEnabled"`
	// If a separate influx db used for an organization in BCP for job telemetry
	IsSeparateInfluxDBUsed bool `json:"isSeparateInfluxDbUsed"`
	// Organization name.
	Name string `json:"name"`
	// NVIDIA Cloud Account Number.
	Nan string `json:"nan"`
	// Org owner.
	OrgOwner OrgListResponseOrgOwner `json:"orgOwner"`
	// Org owners
	OrgOwners []OrgListResponseOrgOwner `json:"orgOwners"`
	// Product end customer salesforce.com Id (external customer Id). pecSfdcId is for
	// EMS (entitlement management service) to track external paid customer.
	PecSfdcID            string                               `json:"pecSfdcId"`
	ProductEnablements   []OrgListResponseProductEnablement   `json:"productEnablements"`
	ProductSubscriptions []OrgListResponseProductSubscription `json:"productSubscriptions"`
	// Repo scan setting definition
	RepoScanSettings OrgListResponseRepoScanSettings `json:"repoScanSettings"`
	Type             OrgListResponseType             `json:"type"`
	// Users information.
	UsersInfo OrgListResponseUsersInfo `json:"usersInfo"`
	JSON      orgListResponseJSON      `json:"-"`
}

Information about the Organization

func (*OrgListResponse) UnmarshalJSON 

func (r *OrgListResponse) UnmarshalJSON(data []byte) (err error)

type OrgListResponseAlternateContact 

type OrgListResponseAlternateContact struct {
	// Alternate contact's email.
	Email string `json:"email"`
	// Full name of the alternate contact.
	FullName string                              `json:"fullName"`
	JSON     orgListResponseAlternateContactJSON `json:"-"`
}

Org Owner Alternate Contact

func (*OrgListResponseAlternateContact) UnmarshalJSON 

func (r *OrgListResponseAlternateContact) UnmarshalJSON(data []byte) (err error)

type OrgListResponseInfinityManagerSettings 

type OrgListResponseInfinityManagerSettings struct {
	// Enable the infinity manager or not. Used both in org and team level object
	InfinityManagerEnabled bool `json:"infinityManagerEnabled"`
	// Allow override settings at team level. Only used in org level object
	InfinityManagerEnableTeamOverride bool                                       `json:"infinityManagerEnableTeamOverride"`
	JSON                              orgListResponseInfinityManagerSettingsJSON `json:"-"`
}

Infinity manager setting definition

func (*OrgListResponseInfinityManagerSettings) UnmarshalJSON 

func (r *OrgListResponseInfinityManagerSettings) UnmarshalJSON(data []byte) (err error)

type OrgListResponseOrgOwner 

type OrgListResponseOrgOwner struct {
	// Email address of the org owner.
	Email string `json:"email,required"`
	// Org owner name.
	FullName string `json:"fullName,required"`
	// Last time the org owner logged in.
	LastLoginDate string                      `json:"lastLoginDate"`
	JSON          orgListResponseOrgOwnerJSON `json:"-"`
}

Org owner.

func (*OrgListResponseOrgOwner) UnmarshalJSON 

func (r *OrgListResponseOrgOwner) UnmarshalJSON(data []byte) (err error)

type OrgListResponseProductEnablement 

type OrgListResponseProductEnablement struct {
	// Product Name (NVAIE, BASE_COMMAND, REGISTRY, etc)
	ProductName string `json:"productName,required"`
	// Product Enablement Types
	Type OrgListResponseProductEnablementsType `json:"type,required"`
	// Date on which the subscription expires. The subscription is invalid after this
	// date. (yyyy-MM-dd)
	ExpirationDate string                                      `json:"expirationDate"`
	PoDetails      []OrgListResponseProductEnablementsPoDetail `json:"poDetails"`
	JSON           orgListResponseProductEnablementJSON        `json:"-"`
}

Product Enablement

func (*OrgListResponseProductEnablement) UnmarshalJSON 

func (r *OrgListResponseProductEnablement) UnmarshalJSON(data []byte) (err error)

type OrgListResponseProductEnablementsPoDetail 

type OrgListResponseProductEnablementsPoDetail struct {
	// Entitlement identifier.
	EntitlementID string `json:"entitlementId"`
	// PAK (Product Activation Key) identifier.
	PkID string                                        `json:"pkId"`
	JSON orgListResponseProductEnablementsPoDetailJSON `json:"-"`
}

Purchase Order.

func (*OrgListResponseProductEnablementsPoDetail) UnmarshalJSON 

func (r *OrgListResponseProductEnablementsPoDetail) UnmarshalJSON(data []byte) (err error)

type OrgListResponseProductEnablementsType 

type OrgListResponseProductEnablementsType string

Product Enablement Types 

const (
	OrgListResponseProductEnablementsTypeNgcAdminEval       OrgListResponseProductEnablementsType = "NGC_ADMIN_EVAL"
	OrgListResponseProductEnablementsTypeNgcAdminNfr        OrgListResponseProductEnablementsType = "NGC_ADMIN_NFR"
	OrgListResponseProductEnablementsTypeNgcAdminCommercial OrgListResponseProductEnablementsType = "NGC_ADMIN_COMMERCIAL"
	OrgListResponseProductEnablementsTypeEmsEval            OrgListResponseProductEnablementsType = "EMS_EVAL"
	OrgListResponseProductEnablementsTypeEmsNfr             OrgListResponseProductEnablementsType = "EMS_NFR"
	OrgListResponseProductEnablementsTypeEmsCommercial      OrgListResponseProductEnablementsType = "EMS_COMMERCIAL"
	OrgListResponseProductEnablementsTypeNgcAdminDeveloper  OrgListResponseProductEnablementsType = "NGC_ADMIN_DEVELOPER"
)

func (OrgListResponseProductEnablementsType) IsKnown 

func (r OrgListResponseProductEnablementsType) IsKnown() bool

type OrgListResponseProductSubscription 

type OrgListResponseProductSubscription struct {
	// Product Name (NVAIE, BASE_COMMAND, FleetCommand, REGISTRY, etc).
	ProductName string `json:"productName,required"`
	// Unique entitlement identifier
	ID string `json:"id"`
	// EMS Subscription type. (options: EMS_EVAL, EMS_NFR and EMS_COMMERCIAL)
	EmsEntitlementType OrgListResponseProductSubscriptionsEmsEntitlementType `json:"emsEntitlementType"`
	// Date on which the subscription expires. The subscription is invalid after this
	// date. (yyyy-MM-dd)
	ExpirationDate string `json:"expirationDate"`
	// Date on which the subscription becomes active. (yyyy-MM-dd)
	StartDate string `json:"startDate"`
	// Subscription type. (options: NGC_ADMIN_EVAL, NGC_ADMIN_NFR,
	// NGC_ADMIN_COMMERCIAL)
	Type OrgListResponseProductSubscriptionsType `json:"type"`
	JSON orgListResponseProductSubscriptionJSON  `json:"-"`
}

Product Subscription

func (*OrgListResponseProductSubscription) UnmarshalJSON 

func (r *OrgListResponseProductSubscription) UnmarshalJSON(data []byte) (err error)

type OrgListResponseProductSubscriptionsEmsEntitlementType 

type OrgListResponseProductSubscriptionsEmsEntitlementType string

EMS Subscription type. (options: EMS_EVAL, EMS_NFR and EMS_COMMERCIAL) 

const (
	OrgListResponseProductSubscriptionsEmsEntitlementTypeEmsEval       OrgListResponseProductSubscriptionsEmsEntitlementType = "EMS_EVAL"
	OrgListResponseProductSubscriptionsEmsEntitlementTypeEmsNfr        OrgListResponseProductSubscriptionsEmsEntitlementType = "EMS_NFR"
	OrgListResponseProductSubscriptionsEmsEntitlementTypeEmsCommerical OrgListResponseProductSubscriptionsEmsEntitlementType = "EMS_COMMERICAL"
	OrgListResponseProductSubscriptionsEmsEntitlementTypeEmsCommercial OrgListResponseProductSubscriptionsEmsEntitlementType = "EMS_COMMERCIAL"
)

func (OrgListResponseProductSubscriptionsEmsEntitlementType) IsKnown 

func (r OrgListResponseProductSubscriptionsEmsEntitlementType) IsKnown() bool

type OrgListResponseProductSubscriptionsType 

type OrgListResponseProductSubscriptionsType string

Subscription type. (options: NGC_ADMIN_EVAL, NGC_ADMIN_NFR, NGC_ADMIN_COMMERCIAL) 

const (
	OrgListResponseProductSubscriptionsTypeNgcAdminEval       OrgListResponseProductSubscriptionsType = "NGC_ADMIN_EVAL"
	OrgListResponseProductSubscriptionsTypeNgcAdminNfr        OrgListResponseProductSubscriptionsType = "NGC_ADMIN_NFR"
	OrgListResponseProductSubscriptionsTypeNgcAdminCommercial OrgListResponseProductSubscriptionsType = "NGC_ADMIN_COMMERCIAL"
)

func (OrgListResponseProductSubscriptionsType) IsKnown 

func (r OrgListResponseProductSubscriptionsType) IsKnown() bool

type OrgListResponseRepoScanSettings 

type OrgListResponseRepoScanSettings struct {
	// Allow org admin to override the org level repo scan settings
	RepoScanAllowOverride bool `json:"repoScanAllowOverride"`
	// Allow repository scanning by default
	RepoScanByDefault bool `json:"repoScanByDefault"`
	// Enable the repository scan or not. Only used in org level object
	RepoScanEnabled bool `json:"repoScanEnabled"`
	// Sends notification to end user after scanning is done
	RepoScanEnableNotifications bool `json:"repoScanEnableNotifications"`
	// Allow override settings at team level. Only used in org level object
	RepoScanEnableTeamOverride bool `json:"repoScanEnableTeamOverride"`
	// Allow showing scan results to CLI or UI
	RepoScanShowResults bool                                `json:"repoScanShowResults"`
	JSON                orgListResponseRepoScanSettingsJSON `json:"-"`
}

Repo scan setting definition

func (*OrgListResponseRepoScanSettings) UnmarshalJSON 

func (r *OrgListResponseRepoScanSettings) UnmarshalJSON(data []byte) (err error)

type OrgListResponseType 

type OrgListResponseType string
const (
	OrgListResponseTypeUnknown    OrgListResponseType = "UNKNOWN"
	OrgListResponseTypeCloud      OrgListResponseType = "CLOUD"
	OrgListResponseTypeEnterprise OrgListResponseType = "ENTERPRISE"
	OrgListResponseTypeIndividual OrgListResponseType = "INDIVIDUAL"
)

func (OrgListResponseType) IsKnown 

func (r OrgListResponseType) IsKnown() bool

type OrgListResponseUsersInfo 

type OrgListResponseUsersInfo struct {
	// Total number of users.
	TotalUsers int64                        `json:"totalUsers"`
	JSON       orgListResponseUsersInfoJSON `json:"-"`
}

Users information.

func (*OrgListResponseUsersInfo) UnmarshalJSON 

func (r *OrgListResponseUsersInfo) UnmarshalJSON(data []byte) (err error)

type OrgMeteringGetAllParams 

type OrgMeteringGetAllParams struct {
	// request params for getting metering usage
	Q param.Field[OrgMeteringGetAllParamsQ] `query:"q,required"`
}

func (OrgMeteringGetAllParams) URLQuery 

func (r OrgMeteringGetAllParams) URLQuery() (v url.Values)

URLQuery serializes OrgMeteringGetAllParams's query parameters as `url.Values`.

type OrgMeteringGetAllParamsQ 

type OrgMeteringGetAllParamsQ struct {
	Measurements param.Field[[]OrgMeteringGetAllParamsQMeasurement] `query:"measurements"`
}

request params for getting metering usage

func (OrgMeteringGetAllParamsQ) URLQuery 

func (r OrgMeteringGetAllParamsQ) URLQuery() (v url.Values)

URLQuery serializes OrgMeteringGetAllParamsQ's query parameters as `url.Values`.

type OrgMeteringGetAllParamsQMeasurement 

type OrgMeteringGetAllParamsQMeasurement struct {
	// this replaces all null values in an output stream with a non-null value that is
	// provided.
	Fill param.Field[float64] `query:"fill"`
	// end time range for the data, in ISO formate, yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
	FromDate param.Field[string] `query:"fromDate"`
	// group by specific tags
	GroupBy param.Field[[]string] `query:"groupBy"`
	// time period to aggregate the data over with, in seconds. If none provided, raw
	// data will be returned.
	PeriodInSeconds param.Field[float64] `query:"periodInSeconds"`
	// start time range for the data, in ISO formate, yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
	ToDate param.Field[string]                                   `query:"toDate"`
	Type   param.Field[OrgMeteringGetAllParamsQMeasurementsType] `query:"type"`
}

object used for sending metering query parameter request

func (OrgMeteringGetAllParamsQMeasurement) URLQuery 

func (r OrgMeteringGetAllParamsQMeasurement) URLQuery() (v url.Values)

URLQuery serializes OrgMeteringGetAllParamsQMeasurement's query parameters as `url.Values`.

type OrgMeteringGetAllParamsQMeasurementsType 

type OrgMeteringGetAllParamsQMeasurementsType string
const (
	OrgMeteringGetAllParamsQMeasurementsTypeEgxGPUUtilizationDaily                   OrgMeteringGetAllParamsQMeasurementsType = "EGX_GPU_UTILIZATION_DAILY"
	OrgMeteringGetAllParamsQMeasurementsTypeFleetCommandGPUUtilizationDaily          OrgMeteringGetAllParamsQMeasurementsType = "FLEET_COMMAND_GPU_UTILIZATION_DAILY"
	OrgMeteringGetAllParamsQMeasurementsTypeEgxLogStorageUtilizationDaily            OrgMeteringGetAllParamsQMeasurementsType = "EGX_LOG_STORAGE_UTILIZATION_DAILY"
	OrgMeteringGetAllParamsQMeasurementsTypeFleetCommandLogStorageUtilizationDaily   OrgMeteringGetAllParamsQMeasurementsType = "FLEET_COMMAND_LOG_STORAGE_UTILIZATION_DAILY"
	OrgMeteringGetAllParamsQMeasurementsTypeRegistryStorageUtilizationDaily          OrgMeteringGetAllParamsQMeasurementsType = "REGISTRY_STORAGE_UTILIZATION_DAILY"
	OrgMeteringGetAllParamsQMeasurementsTypeEgxGPUUtilizationMonthly                 OrgMeteringGetAllParamsQMeasurementsType = "EGX_GPU_UTILIZATION_MONTHLY"
	OrgMeteringGetAllParamsQMeasurementsTypeFleetCommandGPUUtilizationMonthly        OrgMeteringGetAllParamsQMeasurementsType = "FLEET_COMMAND_GPU_UTILIZATION_MONTHLY"
	OrgMeteringGetAllParamsQMeasurementsTypeEgxLogStorageUtilizationMonthly          OrgMeteringGetAllParamsQMeasurementsType = "EGX_LOG_STORAGE_UTILIZATION_MONTHLY"
	OrgMeteringGetAllParamsQMeasurementsTypeFleetCommandLogStorageUtilizationMonthly OrgMeteringGetAllParamsQMeasurementsType = "FLEET_COMMAND_LOG_STORAGE_UTILIZATION_MONTHLY"
	OrgMeteringGetAllParamsQMeasurementsTypeRegistryStorageUtilizationMonthly        OrgMeteringGetAllParamsQMeasurementsType = "REGISTRY_STORAGE_UTILIZATION_MONTHLY"
)

func (OrgMeteringGetAllParamsQMeasurementsType) IsKnown 

func (r OrgMeteringGetAllParamsQMeasurementsType) IsKnown() bool

type OrgMeteringGpupeakGetAllParams 

type OrgMeteringGpupeakGetAllParams struct {
	TheToDateInISO8601FormatIncludingTimeZoneInformationYyyyMmDdTHhMmSS param.Field[OrgMeteringGpupeakGetAllParamsTheToDateInISO8601FormatIncludingTimeZoneInformationYyyyMmDdTHhMmSS] `query:"The to date in ISO 8601 format including time zone information (yyyy-MM-dd'T'HH:mm:ss"`
}

func (OrgMeteringGpupeakGetAllParams) URLQuery 

func (r OrgMeteringGpupeakGetAllParams) URLQuery() (v url.Values)

URLQuery serializes OrgMeteringGpupeakGetAllParams's query parameters as `url.Values`.

type OrgMeteringGpupeakGetAllParamsTheToDateInISO8601FormatIncludingTimeZoneInformationYyyyMmDdTHhMmSS 

type OrgMeteringGpupeakGetAllParamsTheToDateInISO8601FormatIncludingTimeZoneInformationYyyyMmDdTHhMmSS struct {
	Sssz param.Field[time.Time] `query:"SSSZ)" format:"date-time"`
}

func (OrgMeteringGpupeakGetAllParamsTheToDateInISO8601FormatIncludingTimeZoneInformationYyyyMmDdTHhMmSS) URLQuery 

func (r OrgMeteringGpupeakGetAllParamsTheToDateInISO8601FormatIncludingTimeZoneInformationYyyyMmDdTHhMmSS) URLQuery() (v url.Values)

URLQuery serializes OrgMeteringGpupeakGetAllParamsTheToDateInISO8601FormatIncludingTimeZoneInformationYyyyMmDdTHhMmSS's query parameters as `url.Values`.

type OrgMeteringGpupeakService 

type OrgMeteringGpupeakService struct {
	Options []option.RequestOption
}

OrgMeteringGpupeakService contains methods and other services that help with interacting with the ngc API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewOrgMeteringGpupeakService method instead.

func NewOrgMeteringGpupeakService 

func NewOrgMeteringGpupeakService(opts ...option.RequestOption) (r *OrgMeteringGpupeakService)

NewOrgMeteringGpupeakService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*OrgMeteringGpupeakService) GetAll 

func (r *OrgMeteringGpupeakService) GetAll(ctx context.Context, orgName string, query OrgMeteringGpupeakGetAllParams, opts ...option.RequestOption) (res *shared.MeteringResultList, err error)

Returns GPU Peak Usage as measurement series. Requires admin privileges for organization.

type OrgMeteringService 

type OrgMeteringService struct {
	Options []option.RequestOption
	Gpupeak *OrgMeteringGpupeakService
}

OrgMeteringService contains methods and other services that help with interacting with the ngc API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewOrgMeteringService method instead.

func NewOrgMeteringService 

func NewOrgMeteringService(opts ...option.RequestOption) (r *OrgMeteringService)

NewOrgMeteringService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*OrgMeteringService) GetAll 

func (r *OrgMeteringService) GetAll(ctx context.Context, orgName string, query OrgMeteringGetAllParams, opts ...option.RequestOption) (res *shared.MeteringResultList, err error)

Returns Private Registry / EGX resources usage metering as measurement series. Requires admin privileges for organization.

type OrgNewParams 

type OrgNewParams struct {
	// user country
	Country param.Field[string] `json:"country"`
	// optional description of the organization
	Description param.Field[string] `json:"description"`
	// Name of the organization that will be shown to users.
	DisplayName param.Field[string] `json:"displayName"`
	// Identify the initiator of the org request
	Initiator param.Field[string] `json:"initiator"`
	// Is NVIDIA internal org or not
	IsInternal param.Field[bool] `json:"isInternal"`
	// Organization name
	Name param.Field[string] `json:"name"`
	// NVIDIA Cloud Account Identifier
	NcaID param.Field[string] `json:"ncaId"`
	// NVIDIA Cloud Account Number
	NcaNumber param.Field[string] `json:"ncaNumber"`
	// Org owner.
	OrgOwner param.Field[OrgNewParamsOrgOwner] `json:"orgOwner"`
	// product end customer name for enterprise(Fleet Command) product
	PecName param.Field[string] `json:"pecName"`
	// product end customer salesforce.com Id (external customer Id) for
	// enterprise(Fleet Command) product
	PecSfdcID          param.Field[string]                          `json:"pecSfdcId"`
	ProductEnablements param.Field[[]OrgNewParamsProductEnablement] `json:"productEnablements"`
	// This should be deprecated, use productEnablements instead
	ProductSubscriptions param.Field[[]OrgNewParamsProductSubscription] `json:"productSubscriptions"`
	// Proto org identifier
	ProtoOrgID param.Field[string] `json:"protoOrgId"`
	// Company or organization industry
	SalesforceAccountIndustry param.Field[string] `json:"salesforceAccountIndustry"`
	// Send email to org owner or not. Default is true
	SendEmail param.Field[bool]             `json:"sendEmail"`
	Type      param.Field[OrgNewParamsType] `json:"type"`
	Ncid      param.Field[string]           `cookie:"ncid"`
	VisitorID param.Field[string]           `cookie:"VisitorID"`
}

func (OrgNewParams) MarshalJSON 

func (r OrgNewParams) MarshalJSON() (data []byte, err error)

type OrgNewParamsOrgOwner 

type OrgNewParamsOrgOwner struct {
	// Email address of the org owner.
	Email param.Field[string] `json:"email,required"`
	// Org owner name.
	FullName param.Field[string] `json:"fullName"`
	// Identity Provider ID of the org owner.
	IdpID param.Field[string] `json:"idpId"`
	// Starfleet ID of the org owner.
	StarfleetID param.Field[string] `json:"starfleetId"`
}

Org owner.

func (OrgNewParamsOrgOwner) MarshalJSON 

func (r OrgNewParamsOrgOwner) MarshalJSON() (data []byte, err error)

type OrgNewParamsProductEnablement 

type OrgNewParamsProductEnablement struct {
	// Product Name (NVAIE, BASE_COMMAND, REGISTRY, etc)
	ProductName param.Field[string] `json:"productName,required"`
	// Product Enablement Types
	Type param.Field[OrgNewParamsProductEnablementsType] `json:"type,required"`
	// Date on which the subscription expires. The subscription is invalid after this
	// date. (yyyy-MM-dd)
	ExpirationDate param.Field[string]                                   `json:"expirationDate"`
	PoDetails      param.Field[[]OrgNewParamsProductEnablementsPoDetail] `json:"poDetails"`
}

Product Enablement

func (OrgNewParamsProductEnablement) MarshalJSON 

func (r OrgNewParamsProductEnablement) MarshalJSON() (data []byte, err error)

type OrgNewParamsProductEnablementsPoDetail 

type OrgNewParamsProductEnablementsPoDetail struct {
	// Entitlement identifier.
	EntitlementID param.Field[string] `json:"entitlementId"`
	// PAK (Product Activation Key) identifier.
	PkID param.Field[string] `json:"pkId"`
}

Purchase Order.

func (OrgNewParamsProductEnablementsPoDetail) MarshalJSON 

func (r OrgNewParamsProductEnablementsPoDetail) MarshalJSON() (data []byte, err error)

type OrgNewParamsProductEnablementsType 

type OrgNewParamsProductEnablementsType string

Product Enablement Types 

const (
	OrgNewParamsProductEnablementsTypeNgcAdminEval       OrgNewParamsProductEnablementsType = "NGC_ADMIN_EVAL"
	OrgNewParamsProductEnablementsTypeNgcAdminNfr        OrgNewParamsProductEnablementsType = "NGC_ADMIN_NFR"
	OrgNewParamsProductEnablementsTypeNgcAdminCommercial OrgNewParamsProductEnablementsType = "NGC_ADMIN_COMMERCIAL"
	OrgNewParamsProductEnablementsTypeEmsEval            OrgNewParamsProductEnablementsType = "EMS_EVAL"
	OrgNewParamsProductEnablementsTypeEmsNfr             OrgNewParamsProductEnablementsType = "EMS_NFR"
	OrgNewParamsProductEnablementsTypeEmsCommercial      OrgNewParamsProductEnablementsType = "EMS_COMMERCIAL"
	OrgNewParamsProductEnablementsTypeNgcAdminDeveloper  OrgNewParamsProductEnablementsType = "NGC_ADMIN_DEVELOPER"
)

func (OrgNewParamsProductEnablementsType) IsKnown 

func (r OrgNewParamsProductEnablementsType) IsKnown() bool

type OrgNewParamsProductSubscription 

type OrgNewParamsProductSubscription struct {
	// Product Name (NVAIE, BASE_COMMAND, FleetCommand, REGISTRY, etc).
	ProductName param.Field[string] `json:"productName,required"`
	// Unique entitlement identifier
	ID param.Field[string] `json:"id"`
	// EMS Subscription type. (options: EMS_EVAL, EMS_NFR and EMS_COMMERCIAL)
	EmsEntitlementType param.Field[OrgNewParamsProductSubscriptionsEmsEntitlementType] `json:"emsEntitlementType"`
	// Date on which the subscription expires. The subscription is invalid after this
	// date. (yyyy-MM-dd)
	ExpirationDate param.Field[string] `json:"expirationDate"`
	// Date on which the subscription becomes active. (yyyy-MM-dd)
	StartDate param.Field[string] `json:"startDate"`
	// Subscription type. (options: NGC_ADMIN_EVAL, NGC_ADMIN_NFR,
	// NGC_ADMIN_COMMERCIAL)
	Type param.Field[OrgNewParamsProductSubscriptionsType] `json:"type"`
}

Product Subscription

func (OrgNewParamsProductSubscription) MarshalJSON 

func (r OrgNewParamsProductSubscription) MarshalJSON() (data []byte, err error)

type OrgNewParamsProductSubscriptionsEmsEntitlementType 

type OrgNewParamsProductSubscriptionsEmsEntitlementType string

EMS Subscription type. (options: EMS_EVAL, EMS_NFR and EMS_COMMERCIAL) 

const (
	OrgNewParamsProductSubscriptionsEmsEntitlementTypeEmsEval       OrgNewParamsProductSubscriptionsEmsEntitlementType = "EMS_EVAL"
	OrgNewParamsProductSubscriptionsEmsEntitlementTypeEmsNfr        OrgNewParamsProductSubscriptionsEmsEntitlementType = "EMS_NFR"
	OrgNewParamsProductSubscriptionsEmsEntitlementTypeEmsCommerical OrgNewParamsProductSubscriptionsEmsEntitlementType = "EMS_COMMERICAL"
	OrgNewParamsProductSubscriptionsEmsEntitlementTypeEmsCommercial OrgNewParamsProductSubscriptionsEmsEntitlementType = "EMS_COMMERCIAL"
)

func (OrgNewParamsProductSubscriptionsEmsEntitlementType) IsKnown 

func (r OrgNewParamsProductSubscriptionsEmsEntitlementType) IsKnown() bool

type OrgNewParamsProductSubscriptionsType 

type OrgNewParamsProductSubscriptionsType string

Subscription type. (options: NGC_ADMIN_EVAL, NGC_ADMIN_NFR, NGC_ADMIN_COMMERCIAL) 

const (
	OrgNewParamsProductSubscriptionsTypeNgcAdminEval       OrgNewParamsProductSubscriptionsType = "NGC_ADMIN_EVAL"
	OrgNewParamsProductSubscriptionsTypeNgcAdminNfr        OrgNewParamsProductSubscriptionsType = "NGC_ADMIN_NFR"
	OrgNewParamsProductSubscriptionsTypeNgcAdminCommercial OrgNewParamsProductSubscriptionsType = "NGC_ADMIN_COMMERCIAL"
)

func (OrgNewParamsProductSubscriptionsType) IsKnown 

func (r OrgNewParamsProductSubscriptionsType) IsKnown() bool

type OrgNewParamsType 

type OrgNewParamsType string
const (
	OrgNewParamsTypeUnknown    OrgNewParamsType = "UNKNOWN"
	OrgNewParamsTypeCloud      OrgNewParamsType = "CLOUD"
	OrgNewParamsTypeEnterprise OrgNewParamsType = "ENTERPRISE"
	OrgNewParamsTypeIndividual OrgNewParamsType = "INDIVIDUAL"
)

func (OrgNewParamsType) IsKnown 

func (r OrgNewParamsType) IsKnown() bool

type OrgProtoOrgNewParams 

type OrgProtoOrgNewParams struct {
	// user country
	Country param.Field[string] `json:"country"`
	// optional description of the organization
	Description param.Field[string] `json:"description"`
	// Name of the organization that will be shown to users.
	DisplayName param.Field[string] `json:"displayName"`
	// Identify the initiator of the org request
	Initiator param.Field[string] `json:"initiator"`
	// Is NVIDIA internal org or not
	IsInternal param.Field[bool] `json:"isInternal"`
	// Organization name
	Name param.Field[string] `json:"name"`
	// NVIDIA Cloud Account Identifier
	NcaID param.Field[string] `json:"ncaId"`
	// NVIDIA Cloud Account Number
	NcaNumber param.Field[string] `json:"ncaNumber"`
	// Org owner.
	OrgOwner param.Field[OrgProtoOrgNewParamsOrgOwner] `json:"orgOwner"`
	// product end customer name for enterprise(Fleet Command) product
	PecName param.Field[string] `json:"pecName"`
	// product end customer salesforce.com Id (external customer Id) for
	// enterprise(Fleet Command) product
	PecSfdcID          param.Field[string]                                  `json:"pecSfdcId"`
	ProductEnablements param.Field[[]OrgProtoOrgNewParamsProductEnablement] `json:"productEnablements"`
	// This should be deprecated, use productEnablements instead
	ProductSubscriptions param.Field[[]OrgProtoOrgNewParamsProductSubscription] `json:"productSubscriptions"`
	// Proto org identifier
	ProtoOrgID param.Field[string] `json:"protoOrgId"`
	// Company or organization industry
	SalesforceAccountIndustry param.Field[string] `json:"salesforceAccountIndustry"`
	// Send email to org owner or not. Default is true
	SendEmail param.Field[bool]                     `json:"sendEmail"`
	Type      param.Field[OrgProtoOrgNewParamsType] `json:"type"`
	Ncid      param.Field[string]                   `cookie:"ncid"`
	VisitorID param.Field[string]                   `cookie:"VisitorID"`
}

func (OrgProtoOrgNewParams) MarshalJSON 

func (r OrgProtoOrgNewParams) MarshalJSON() (data []byte, err error)

type OrgProtoOrgNewParamsOrgOwner 

type OrgProtoOrgNewParamsOrgOwner struct {
	// Email address of the org owner.
	Email param.Field[string] `json:"email,required"`
	// Org owner name.
	FullName param.Field[string] `json:"fullName"`
	// Identity Provider ID of the org owner.
	IdpID param.Field[string] `json:"idpId"`
	// Starfleet ID of the org owner.
	StarfleetID param.Field[string] `json:"starfleetId"`
}

Org owner.

func (OrgProtoOrgNewParamsOrgOwner) MarshalJSON 

func (r OrgProtoOrgNewParamsOrgOwner) MarshalJSON() (data []byte, err error)

type OrgProtoOrgNewParamsProductEnablement 

type OrgProtoOrgNewParamsProductEnablement struct {
	// Product Name (NVAIE, BASE_COMMAND, REGISTRY, etc)
	ProductName param.Field[string] `json:"productName,required"`
	// Product Enablement Types
	Type param.Field[OrgProtoOrgNewParamsProductEnablementsType] `json:"type,required"`
	// Date on which the subscription expires. The subscription is invalid after this
	// date. (yyyy-MM-dd)
	ExpirationDate param.Field[string]                                           `json:"expirationDate"`
	PoDetails      param.Field[[]OrgProtoOrgNewParamsProductEnablementsPoDetail] `json:"poDetails"`
}

Product Enablement

func (OrgProtoOrgNewParamsProductEnablement) MarshalJSON 

func (r OrgProtoOrgNewParamsProductEnablement) MarshalJSON() (data []byte, err error)

type OrgProtoOrgNewParamsProductEnablementsPoDetail 

type OrgProtoOrgNewParamsProductEnablementsPoDetail struct {
	// Entitlement identifier.
	EntitlementID param.Field[string] `json:"entitlementId"`
	// PAK (Product Activation Key) identifier.
	PkID param.Field[string] `json:"pkId"`
}

Purchase Order.

func (OrgProtoOrgNewParamsProductEnablementsPoDetail) MarshalJSON 

func (r OrgProtoOrgNewParamsProductEnablementsPoDetail) MarshalJSON() (data []byte, err error)

type OrgProtoOrgNewParamsProductEnablementsType 

type OrgProtoOrgNewParamsProductEnablementsType string

Product Enablement Types 

const (
	OrgProtoOrgNewParamsProductEnablementsTypeNgcAdminEval       OrgProtoOrgNewParamsProductEnablementsType = "NGC_ADMIN_EVAL"
	OrgProtoOrgNewParamsProductEnablementsTypeNgcAdminNfr        OrgProtoOrgNewParamsProductEnablementsType = "NGC_ADMIN_NFR"
	OrgProtoOrgNewParamsProductEnablementsTypeNgcAdminCommercial OrgProtoOrgNewParamsProductEnablementsType = "NGC_ADMIN_COMMERCIAL"
	OrgProtoOrgNewParamsProductEnablementsTypeEmsEval            OrgProtoOrgNewParamsProductEnablementsType = "EMS_EVAL"
	OrgProtoOrgNewParamsProductEnablementsTypeEmsNfr             OrgProtoOrgNewParamsProductEnablementsType = "EMS_NFR"
	OrgProtoOrgNewParamsProductEnablementsTypeEmsCommercial      OrgProtoOrgNewParamsProductEnablementsType = "EMS_COMMERCIAL"
	OrgProtoOrgNewParamsProductEnablementsTypeNgcAdminDeveloper  OrgProtoOrgNewParamsProductEnablementsType = "NGC_ADMIN_DEVELOPER"
)

func (OrgProtoOrgNewParamsProductEnablementsType) IsKnown 

func (r OrgProtoOrgNewParamsProductEnablementsType) IsKnown() bool

type OrgProtoOrgNewParamsProductSubscription 

type OrgProtoOrgNewParamsProductSubscription struct {
	// Product Name (NVAIE, BASE_COMMAND, FleetCommand, REGISTRY, etc).
	ProductName param.Field[string] `json:"productName,required"`
	// Unique entitlement identifier
	ID param.Field[string] `json:"id"`
	// EMS Subscription type. (options: EMS_EVAL, EMS_NFR and EMS_COMMERCIAL)
	EmsEntitlementType param.Field[OrgProtoOrgNewParamsProductSubscriptionsEmsEntitlementType] `json:"emsEntitlementType"`
	// Date on which the subscription expires. The subscription is invalid after this
	// date. (yyyy-MM-dd)
	ExpirationDate param.Field[string] `json:"expirationDate"`
	// Date on which the subscription becomes active. (yyyy-MM-dd)
	StartDate param.Field[string] `json:"startDate"`
	// Subscription type. (options: NGC_ADMIN_EVAL, NGC_ADMIN_NFR,
	// NGC_ADMIN_COMMERCIAL)
	Type param.Field[OrgProtoOrgNewParamsProductSubscriptionsType] `json:"type"`
}

Product Subscription

func (OrgProtoOrgNewParamsProductSubscription) MarshalJSON 

func (r OrgProtoOrgNewParamsProductSubscription) MarshalJSON() (data []byte, err error)

type OrgProtoOrgNewParamsProductSubscriptionsEmsEntitlementType 

type OrgProtoOrgNewParamsProductSubscriptionsEmsEntitlementType string

EMS Subscription type. (options: EMS_EVAL, EMS_NFR and EMS_COMMERCIAL) 

const (
	OrgProtoOrgNewParamsProductSubscriptionsEmsEntitlementTypeEmsEval       OrgProtoOrgNewParamsProductSubscriptionsEmsEntitlementType = "EMS_EVAL"
	OrgProtoOrgNewParamsProductSubscriptionsEmsEntitlementTypeEmsNfr        OrgProtoOrgNewParamsProductSubscriptionsEmsEntitlementType = "EMS_NFR"
	OrgProtoOrgNewParamsProductSubscriptionsEmsEntitlementTypeEmsCommerical OrgProtoOrgNewParamsProductSubscriptionsEmsEntitlementType = "EMS_COMMERICAL"
	OrgProtoOrgNewParamsProductSubscriptionsEmsEntitlementTypeEmsCommercial OrgProtoOrgNewParamsProductSubscriptionsEmsEntitlementType = "EMS_COMMERCIAL"
)

func (OrgProtoOrgNewParamsProductSubscriptionsEmsEntitlementType) IsKnown 

func (r OrgProtoOrgNewParamsProductSubscriptionsEmsEntitlementType) IsKnown() bool

type OrgProtoOrgNewParamsProductSubscriptionsType 

type OrgProtoOrgNewParamsProductSubscriptionsType string

Subscription type. (options: NGC_ADMIN_EVAL, NGC_ADMIN_NFR, NGC_ADMIN_COMMERCIAL) 

const (
	OrgProtoOrgNewParamsProductSubscriptionsTypeNgcAdminEval       OrgProtoOrgNewParamsProductSubscriptionsType = "NGC_ADMIN_EVAL"
	OrgProtoOrgNewParamsProductSubscriptionsTypeNgcAdminNfr        OrgProtoOrgNewParamsProductSubscriptionsType = "NGC_ADMIN_NFR"
	OrgProtoOrgNewParamsProductSubscriptionsTypeNgcAdminCommercial OrgProtoOrgNewParamsProductSubscriptionsType = "NGC_ADMIN_COMMERCIAL"
)

func (OrgProtoOrgNewParamsProductSubscriptionsType) IsKnown 

func (r OrgProtoOrgNewParamsProductSubscriptionsType) IsKnown() bool

type OrgProtoOrgNewParamsType 

type OrgProtoOrgNewParamsType string
const (
	OrgProtoOrgNewParamsTypeUnknown    OrgProtoOrgNewParamsType = "UNKNOWN"
	OrgProtoOrgNewParamsTypeCloud      OrgProtoOrgNewParamsType = "CLOUD"
	OrgProtoOrgNewParamsTypeEnterprise OrgProtoOrgNewParamsType = "ENTERPRISE"
	OrgProtoOrgNewParamsTypeIndividual OrgProtoOrgNewParamsType = "INDIVIDUAL"
)

func (OrgProtoOrgNewParamsType) IsKnown 

func (r OrgProtoOrgNewParamsType) IsKnown() bool

type OrgProtoOrgService 

type OrgProtoOrgService struct {
	Options []option.RequestOption
}

OrgProtoOrgService contains methods and other services that help with interacting with the ngc API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewOrgProtoOrgService method instead.

func NewOrgProtoOrgService 

func NewOrgProtoOrgService(opts ...option.RequestOption) (r *OrgProtoOrgService)

NewOrgProtoOrgService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*OrgProtoOrgService) New 

func (r *OrgProtoOrgService) New(ctx context.Context, params OrgProtoOrgNewParams, opts ...option.RequestOption) (res *OrgResponse, err error)

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

type OrgResponse 

type OrgResponse struct {
	// Information about the Organization
	Organizations OrgResponseOrganizations `json:"organizations"`
	RequestStatus OrgResponseRequestStatus `json:"requestStatus"`
	JSON          orgResponseJSON          `json:"-"`
}

info about an organizations

func (*OrgResponse) UnmarshalJSON 

func (r *OrgResponse) UnmarshalJSON(data []byte) (err error)

type OrgResponseOrganizations 

type OrgResponseOrganizations struct {
	// Unique Id of this team.
	ID int64 `json:"id"`
	// Org Owner Alternate Contact
	AlternateContact OrgResponseOrganizationsAlternateContact `json:"alternateContact"`
	// Billing account ID.
	BillingAccountID string `json:"billingAccountId"`
	// Identifies if the org can be reused.
	CanAddOn bool `json:"canAddOn"`
	// ISO country code of the organization.
	Country string `json:"country"`
	// Optional description of the organization.
	Description string `json:"description"`
	// Name of the organization that will be shown to users.
	DisplayName string `json:"displayName"`
	// Identity Provider ID.
	IdpID string `json:"idpId"`
	// Industry of the organization.
	Industry string `json:"industry"`
	// Infinity manager setting definition
	InfinityManagerSettings OrgResponseOrganizationsInfinityManagerSettings `json:"infinityManagerSettings"`
	// Dataset Service enable flag for an organization
	IsDatasetServiceEnabled bool `json:"isDatasetServiceEnabled"`
	// Is NVIDIA internal org or not
	IsInternal bool `json:"isInternal"`
	// Indicates when the org is a proto org
	IsProto bool `json:"isProto"`
	// Quick Start enable flag for an organization
	IsQuickStartEnabled bool `json:"isQuickStartEnabled"`
	// If a server side encryption is enabled for private registry (models, resources)
	IsRegistrySseEnabled bool `json:"isRegistrySSEEnabled"`
	// Secrets Manager Service enable flag for an organization
	IsSecretsManagerServiceEnabled bool `json:"isSecretsManagerServiceEnabled"`
	// Secure Credential Sharing Service enable flag for an organization
	IsSecureCredentialSharingServiceEnabled bool `json:"isSecureCredentialSharingServiceEnabled"`
	// If a separate influx db used for an organization in BCP for job telemetry
	IsSeparateInfluxDBUsed bool `json:"isSeparateInfluxDbUsed"`
	// Organization name.
	Name string `json:"name"`
	// NVIDIA Cloud Account Number.
	Nan string `json:"nan"`
	// Org owner.
	OrgOwner OrgResponseOrganizationsOrgOwner `json:"orgOwner"`
	// Org owners
	OrgOwners []OrgResponseOrganizationsOrgOwner `json:"orgOwners"`
	// Product end customer salesforce.com Id (external customer Id). pecSfdcId is for
	// EMS (entitlement management service) to track external paid customer.
	PecSfdcID            string                                        `json:"pecSfdcId"`
	ProductEnablements   []OrgResponseOrganizationsProductEnablement   `json:"productEnablements"`
	ProductSubscriptions []OrgResponseOrganizationsProductSubscription `json:"productSubscriptions"`
	// Repo scan setting definition
	RepoScanSettings OrgResponseOrganizationsRepoScanSettings `json:"repoScanSettings"`
	Type             OrgResponseOrganizationsType             `json:"type"`
	// Users information.
	UsersInfo OrgResponseOrganizationsUsersInfo `json:"usersInfo"`
	JSON      orgResponseOrganizationsJSON      `json:"-"`
}

Information about the Organization

func (*OrgResponseOrganizations) UnmarshalJSON 

func (r *OrgResponseOrganizations) UnmarshalJSON(data []byte) (err error)

type OrgResponseOrganizationsAlternateContact 

type OrgResponseOrganizationsAlternateContact struct {
	// Alternate contact's email.
	Email string `json:"email"`
	// Full name of the alternate contact.
	FullName string                                       `json:"fullName"`
	JSON     orgResponseOrganizationsAlternateContactJSON `json:"-"`
}

Org Owner Alternate Contact

func (*OrgResponseOrganizationsAlternateContact) UnmarshalJSON 

func (r *OrgResponseOrganizationsAlternateContact) UnmarshalJSON(data []byte) (err error)

type OrgResponseOrganizationsInfinityManagerSettings 

type OrgResponseOrganizationsInfinityManagerSettings struct {
	// Enable the infinity manager or not. Used both in org and team level object
	InfinityManagerEnabled bool `json:"infinityManagerEnabled"`
	// Allow override settings at team level. Only used in org level object
	InfinityManagerEnableTeamOverride bool                                                `json:"infinityManagerEnableTeamOverride"`
	JSON                              orgResponseOrganizationsInfinityManagerSettingsJSON `json:"-"`
}

Infinity manager setting definition

func (*OrgResponseOrganizationsInfinityManagerSettings) UnmarshalJSON 

func (r *OrgResponseOrganizationsInfinityManagerSettings) UnmarshalJSON(data []byte) (err error)

type OrgResponseOrganizationsOrgOwner 

type OrgResponseOrganizationsOrgOwner struct {
	// Email address of the org owner.
	Email string `json:"email,required"`
	// Org owner name.
	FullName string `json:"fullName,required"`
	// Last time the org owner logged in.
	LastLoginDate string                               `json:"lastLoginDate"`
	JSON          orgResponseOrganizationsOrgOwnerJSON `json:"-"`
}

Org owner.

func (*OrgResponseOrganizationsOrgOwner) UnmarshalJSON 

func (r *OrgResponseOrganizationsOrgOwner) UnmarshalJSON(data []byte) (err error)

type OrgResponseOrganizationsProductEnablement 

type OrgResponseOrganizationsProductEnablement struct {
	// Product Name (NVAIE, BASE_COMMAND, REGISTRY, etc)
	ProductName string `json:"productName,required"`
	// Product Enablement Types
	Type OrgResponseOrganizationsProductEnablementsType `json:"type,required"`
	// Date on which the subscription expires. The subscription is invalid after this
	// date. (yyyy-MM-dd)
	ExpirationDate string                                               `json:"expirationDate"`
	PoDetails      []OrgResponseOrganizationsProductEnablementsPoDetail `json:"poDetails"`
	JSON           orgResponseOrganizationsProductEnablementJSON        `json:"-"`
}

Product Enablement

func (*OrgResponseOrganizationsProductEnablement) UnmarshalJSON 

func (r *OrgResponseOrganizationsProductEnablement) UnmarshalJSON(data []byte) (err error)

type OrgResponseOrganizationsProductEnablementsPoDetail 

type OrgResponseOrganizationsProductEnablementsPoDetail struct {
	// Entitlement identifier.
	EntitlementID string `json:"entitlementId"`
	// PAK (Product Activation Key) identifier.
	PkID string                                                 `json:"pkId"`
	JSON orgResponseOrganizationsProductEnablementsPoDetailJSON `json:"-"`
}

Purchase Order.

func (*OrgResponseOrganizationsProductEnablementsPoDetail) UnmarshalJSON 

func (r *OrgResponseOrganizationsProductEnablementsPoDetail) UnmarshalJSON(data []byte) (err error)

type OrgResponseOrganizationsProductEnablementsType 

type OrgResponseOrganizationsProductEnablementsType string

Product Enablement Types 

const (
	OrgResponseOrganizationsProductEnablementsTypeNgcAdminEval       OrgResponseOrganizationsProductEnablementsType = "NGC_ADMIN_EVAL"
	OrgResponseOrganizationsProductEnablementsTypeNgcAdminNfr        OrgResponseOrganizationsProductEnablementsType = "NGC_ADMIN_NFR"
	OrgResponseOrganizationsProductEnablementsTypeNgcAdminCommercial OrgResponseOrganizationsProductEnablementsType = "NGC_ADMIN_COMMERCIAL"
	OrgResponseOrganizationsProductEnablementsTypeEmsEval            OrgResponseOrganizationsProductEnablementsType = "EMS_EVAL"
	OrgResponseOrganizationsProductEnablementsTypeEmsNfr             OrgResponseOrganizationsProductEnablementsType = "EMS_NFR"
	OrgResponseOrganizationsProductEnablementsTypeEmsCommercial      OrgResponseOrganizationsProductEnablementsType = "EMS_COMMERCIAL"
	OrgResponseOrganizationsProductEnablementsTypeNgcAdminDeveloper  OrgResponseOrganizationsProductEnablementsType = "NGC_ADMIN_DEVELOPER"
)

func (OrgResponseOrganizationsProductEnablementsType) IsKnown 

func (r OrgResponseOrganizationsProductEnablementsType) IsKnown() bool

type OrgResponseOrganizationsProductSubscription 

type OrgResponseOrganizationsProductSubscription struct {
	// Product Name (NVAIE, BASE_COMMAND, FleetCommand, REGISTRY, etc).
	ProductName string `json:"productName,required"`
	// Unique entitlement identifier
	ID string `json:"id"`
	// EMS Subscription type. (options: EMS_EVAL, EMS_NFR and EMS_COMMERCIAL)
	EmsEntitlementType OrgResponseOrganizationsProductSubscriptionsEmsEntitlementType `json:"emsEntitlementType"`
	// Date on which the subscription expires. The subscription is invalid after this
	// date. (yyyy-MM-dd)
	ExpirationDate string `json:"expirationDate"`
	// Date on which the subscription becomes active. (yyyy-MM-dd)
	StartDate string `json:"startDate"`
	// Subscription type. (options: NGC_ADMIN_EVAL, NGC_ADMIN_NFR,
	// NGC_ADMIN_COMMERCIAL)
	Type OrgResponseOrganizationsProductSubscriptionsType `json:"type"`
	JSON orgResponseOrganizationsProductSubscriptionJSON  `json:"-"`
}

Product Subscription

func (*OrgResponseOrganizationsProductSubscription) UnmarshalJSON 

func (r *OrgResponseOrganizationsProductSubscription) UnmarshalJSON(data []byte) (err error)

type OrgResponseOrganizationsProductSubscriptionsEmsEntitlementType 

type OrgResponseOrganizationsProductSubscriptionsEmsEntitlementType string

EMS Subscription type. (options: EMS_EVAL, EMS_NFR and EMS_COMMERCIAL) 

const (
	OrgResponseOrganizationsProductSubscriptionsEmsEntitlementTypeEmsEval       OrgResponseOrganizationsProductSubscriptionsEmsEntitlementType = "EMS_EVAL"
	OrgResponseOrganizationsProductSubscriptionsEmsEntitlementTypeEmsNfr        OrgResponseOrganizationsProductSubscriptionsEmsEntitlementType = "EMS_NFR"
	OrgResponseOrganizationsProductSubscriptionsEmsEntitlementTypeEmsCommerical OrgResponseOrganizationsProductSubscriptionsEmsEntitlementType = "EMS_COMMERICAL"
	OrgResponseOrganizationsProductSubscriptionsEmsEntitlementTypeEmsCommercial OrgResponseOrganizationsProductSubscriptionsEmsEntitlementType = "EMS_COMMERCIAL"
)

func (OrgResponseOrganizationsProductSubscriptionsEmsEntitlementType) IsKnown 

func (r OrgResponseOrganizationsProductSubscriptionsEmsEntitlementType) IsKnown() bool

type OrgResponseOrganizationsProductSubscriptionsType 

type OrgResponseOrganizationsProductSubscriptionsType string

Subscription type. (options: NGC_ADMIN_EVAL, NGC_ADMIN_NFR, NGC_ADMIN_COMMERCIAL) 

const (
	OrgResponseOrganizationsProductSubscriptionsTypeNgcAdminEval       OrgResponseOrganizationsProductSubscriptionsType = "NGC_ADMIN_EVAL"
	OrgResponseOrganizationsProductSubscriptionsTypeNgcAdminNfr        OrgResponseOrganizationsProductSubscriptionsType = "NGC_ADMIN_NFR"
	OrgResponseOrganizationsProductSubscriptionsTypeNgcAdminCommercial OrgResponseOrganizationsProductSubscriptionsType = "NGC_ADMIN_COMMERCIAL"
)

func (OrgResponseOrganizationsProductSubscriptionsType) IsKnown 

func (r OrgResponseOrganizationsProductSubscriptionsType) IsKnown() bool

type OrgResponseOrganizationsRepoScanSettings 

type OrgResponseOrganizationsRepoScanSettings struct {
	// Allow org admin to override the org level repo scan settings
	RepoScanAllowOverride bool `json:"repoScanAllowOverride"`
	// Allow repository scanning by default
	RepoScanByDefault bool `json:"repoScanByDefault"`
	// Enable the repository scan or not. Only used in org level object
	RepoScanEnabled bool `json:"repoScanEnabled"`
	// Sends notification to end user after scanning is done
	RepoScanEnableNotifications bool `json:"repoScanEnableNotifications"`
	// Allow override settings at team level. Only used in org level object
	RepoScanEnableTeamOverride bool `json:"repoScanEnableTeamOverride"`
	// Allow showing scan results to CLI or UI
	RepoScanShowResults bool                                         `json:"repoScanShowResults"`
	JSON                orgResponseOrganizationsRepoScanSettingsJSON `json:"-"`
}

Repo scan setting definition

func (*OrgResponseOrganizationsRepoScanSettings) UnmarshalJSON 

func (r *OrgResponseOrganizationsRepoScanSettings) UnmarshalJSON(data []byte) (err error)

type OrgResponseOrganizationsType 

type OrgResponseOrganizationsType string
const (
	OrgResponseOrganizationsTypeUnknown    OrgResponseOrganizationsType = "UNKNOWN"
	OrgResponseOrganizationsTypeCloud      OrgResponseOrganizationsType = "CLOUD"
	OrgResponseOrganizationsTypeEnterprise OrgResponseOrganizationsType = "ENTERPRISE"
	OrgResponseOrganizationsTypeIndividual OrgResponseOrganizationsType = "INDIVIDUAL"
)

func (OrgResponseOrganizationsType) IsKnown 

func (r OrgResponseOrganizationsType) IsKnown() bool

type OrgResponseOrganizationsUsersInfo 

type OrgResponseOrganizationsUsersInfo struct {
	// Total number of users.
	TotalUsers int64                                 `json:"totalUsers"`
	JSON       orgResponseOrganizationsUsersInfoJSON `json:"-"`
}

Users information.

func (*OrgResponseOrganizationsUsersInfo) UnmarshalJSON 

func (r *OrgResponseOrganizationsUsersInfo) UnmarshalJSON(data []byte) (err error)

type OrgResponseRequestStatus 

type OrgResponseRequestStatus struct {
	RequestID string `json:"requestId"`
	ServerID  string `json:"serverId"`
	// Describes response status reported by the server.
	StatusCode        OrgResponseRequestStatusStatusCode `json:"statusCode"`
	StatusDescription string                             `json:"statusDescription"`
	JSON              orgResponseRequestStatusJSON       `json:"-"`
}

func (*OrgResponseRequestStatus) UnmarshalJSON 

func (r *OrgResponseRequestStatus) UnmarshalJSON(data []byte) (err error)

type OrgResponseRequestStatusStatusCode 

type OrgResponseRequestStatusStatusCode string

Describes response status reported by the server. 

const (
	OrgResponseRequestStatusStatusCodeUnknown                    OrgResponseRequestStatusStatusCode = "UNKNOWN"
	OrgResponseRequestStatusStatusCodeSuccess                    OrgResponseRequestStatusStatusCode = "SUCCESS"
	OrgResponseRequestStatusStatusCodeUnauthorized               OrgResponseRequestStatusStatusCode = "UNAUTHORIZED"
	OrgResponseRequestStatusStatusCodePaymentRequired            OrgResponseRequestStatusStatusCode = "PAYMENT_REQUIRED"
	OrgResponseRequestStatusStatusCodeForbidden                  OrgResponseRequestStatusStatusCode = "FORBIDDEN"
	OrgResponseRequestStatusStatusCodeTimeout                    OrgResponseRequestStatusStatusCode = "TIMEOUT"
	OrgResponseRequestStatusStatusCodeExists                     OrgResponseRequestStatusStatusCode = "EXISTS"
	OrgResponseRequestStatusStatusCodeNotFound                   OrgResponseRequestStatusStatusCode = "NOT_FOUND"
	OrgResponseRequestStatusStatusCodeInternalError              OrgResponseRequestStatusStatusCode = "INTERNAL_ERROR"
	OrgResponseRequestStatusStatusCodeInvalidRequest             OrgResponseRequestStatusStatusCode = "INVALID_REQUEST"
	OrgResponseRequestStatusStatusCodeInvalidRequestVersion      OrgResponseRequestStatusStatusCode = "INVALID_REQUEST_VERSION"
	OrgResponseRequestStatusStatusCodeInvalidRequestData         OrgResponseRequestStatusStatusCode = "INVALID_REQUEST_DATA"
	OrgResponseRequestStatusStatusCodeMethodNotAllowed           OrgResponseRequestStatusStatusCode = "METHOD_NOT_ALLOWED"
	OrgResponseRequestStatusStatusCodeConflict                   OrgResponseRequestStatusStatusCode = "CONFLICT"
	OrgResponseRequestStatusStatusCodeUnprocessableEntity        OrgResponseRequestStatusStatusCode = "UNPROCESSABLE_ENTITY"
	OrgResponseRequestStatusStatusCodeTooManyRequests            OrgResponseRequestStatusStatusCode = "TOO_MANY_REQUESTS"
	OrgResponseRequestStatusStatusCodeInsufficientStorage        OrgResponseRequestStatusStatusCode = "INSUFFICIENT_STORAGE"
	OrgResponseRequestStatusStatusCodeServiceUnavailable         OrgResponseRequestStatusStatusCode = "SERVICE_UNAVAILABLE"
	OrgResponseRequestStatusStatusCodePayloadTooLarge            OrgResponseRequestStatusStatusCode = "PAYLOAD_TOO_LARGE"
	OrgResponseRequestStatusStatusCodeNotAcceptable              OrgResponseRequestStatusStatusCode = "NOT_ACCEPTABLE"
	OrgResponseRequestStatusStatusCodeUnavailableForLegalReasons OrgResponseRequestStatusStatusCode = "UNAVAILABLE_FOR_LEGAL_REASONS"
	OrgResponseRequestStatusStatusCodeBadGateway                 OrgResponseRequestStatusStatusCode = "BAD_GATEWAY"
)

func (OrgResponseRequestStatusStatusCode) IsKnown 

func (r OrgResponseRequestStatusStatusCode) IsKnown() bool

type OrgService 

type OrgService struct {
	Options      []option.RequestOption
	Users        *OrgUserService
	Teams        *OrgTeamService
	ProtoOrg     *OrgProtoOrgService
	Credits      *OrgCreditService
	StarfleetIDs *OrgStarfleetIDService
	Metering     *OrgMeteringService
	AuditLogs    *OrgAuditLogService
}

OrgService contains methods and other services that help with interacting with the ngc API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewOrgService method instead.

func NewOrgService 

func NewOrgService(opts ...option.RequestOption) (r *OrgService)

NewOrgService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*OrgService) Get 

func (r *OrgService) Get(ctx context.Context, orgName string, opts ...option.RequestOption) (res *OrgResponse, err error)

Get organization information

func (*OrgService) List 

func (r *OrgService) List(ctx context.Context, query OrgListParams, opts ...option.RequestOption) (res *pagination.PageNumberOrganizations[OrgListResponse], err error)

List all organizations of the user

func (*OrgService) ListAutoPaging 

func (r *OrgService) ListAutoPaging(ctx context.Context, query OrgListParams, opts ...option.RequestOption) *pagination.PageNumberOrganizationsAutoPager[OrgListResponse]

List all organizations of the user

func (*OrgService) New 

func (r *OrgService) New(ctx context.Context, params OrgNewParams, opts ...option.RequestOption) (res *OrgResponse, err error)

Create a new organization based on the org info provided in the request.

func (*OrgService) Update 

func (r *OrgService) Update(ctx context.Context, orgName string, body OrgUpdateParams, opts ...option.RequestOption) (res *OrgResponse, err error)

Update organization information

type OrgStarfleetIDService 

type OrgStarfleetIDService struct {
	Options []option.RequestOption
}

OrgStarfleetIDService contains methods and other services that help with interacting with the ngc API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewOrgStarfleetIDService method instead.

func NewOrgStarfleetIDService 

func NewOrgStarfleetIDService(opts ...option.RequestOption) (r *OrgStarfleetIDService)

NewOrgStarfleetIDService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*OrgStarfleetIDService) Get 

func (r *OrgStarfleetIDService) Get(ctx context.Context, orgName string, starfleetID string, opts ...option.RequestOption) (res *shared.User, err error)

Get User details in org by starfleet Id

type OrgTeamListParams 

type OrgTeamListParams struct {
	// The page number of result
	PageNumber param.Field[int64] `query:"page-number"`
	// The page size of result
	PageSize param.Field[int64] `query:"page-size"`
}

func (OrgTeamListParams) URLQuery 

func (r OrgTeamListParams) URLQuery() (v url.Values)

URLQuery serializes OrgTeamListParams's query parameters as `url.Values`.

type OrgTeamListResponse 

type OrgTeamListResponse struct {
	// unique Id of this team.
	ID int64 `json:"id"`
	// description of the team
	Description string `json:"description"`
	// Infinity manager setting definition
	InfinityManagerSettings OrgTeamListResponseInfinityManagerSettings `json:"infinityManagerSettings"`
	// indicates if the team is deleted or not
	IsDeleted bool `json:"isDeleted"`
	// team name
	Name string `json:"name"`
	// Repo scan setting definition
	RepoScanSettings OrgTeamListResponseRepoScanSettings `json:"repoScanSettings"`
	JSON             orgTeamListResponseJSON             `json:"-"`
}

Information about the team

func (*OrgTeamListResponse) UnmarshalJSON 

func (r *OrgTeamListResponse) UnmarshalJSON(data []byte) (err error)

type OrgTeamListResponseInfinityManagerSettings 

type OrgTeamListResponseInfinityManagerSettings struct {
	// Enable the infinity manager or not. Used both in org and team level object
	InfinityManagerEnabled bool `json:"infinityManagerEnabled"`
	// Allow override settings at team level. Only used in org level object
	InfinityManagerEnableTeamOverride bool                                           `json:"infinityManagerEnableTeamOverride"`
	JSON                              orgTeamListResponseInfinityManagerSettingsJSON `json:"-"`
}

Infinity manager setting definition

func (*OrgTeamListResponseInfinityManagerSettings) UnmarshalJSON 

func (r *OrgTeamListResponseInfinityManagerSettings) UnmarshalJSON(data []byte) (err error)

type OrgTeamListResponseRepoScanSettings 

type OrgTeamListResponseRepoScanSettings struct {
	// Allow org admin to override the org level repo scan settings
	RepoScanAllowOverride bool `json:"repoScanAllowOverride"`
	// Allow repository scanning by default
	RepoScanByDefault bool `json:"repoScanByDefault"`
	// Enable the repository scan or not. Only used in org level object
	RepoScanEnabled bool `json:"repoScanEnabled"`
	// Sends notification to end user after scanning is done
	RepoScanEnableNotifications bool `json:"repoScanEnableNotifications"`
	// Allow override settings at team level. Only used in org level object
	RepoScanEnableTeamOverride bool `json:"repoScanEnableTeamOverride"`
	// Allow showing scan results to CLI or UI
	RepoScanShowResults bool                                    `json:"repoScanShowResults"`
	JSON                orgTeamListResponseRepoScanSettingsJSON `json:"-"`
}

Repo scan setting definition

func (*OrgTeamListResponseRepoScanSettings) UnmarshalJSON 

func (r *OrgTeamListResponseRepoScanSettings) UnmarshalJSON(data []byte) (err error)

type OrgTeamNcaInvitationNewParams 

type OrgTeamNcaInvitationNewParams struct {
	// Is the user email
	Email param.Field[string] `json:"email"`
	// Is the numbers of days the invitation will expire
	InvitationExpirationIn param.Field[int64] `json:"invitationExpirationIn"`
	// Nca allow users to be invited as Admin and as Member
	InviteAs param.Field[OrgTeamNcaInvitationNewParamsInviteAs] `json:"inviteAs"`
	// Is a message to the new user
	Message param.Field[string] `json:"message"`
}

func (OrgTeamNcaInvitationNewParams) MarshalJSON 

func (r OrgTeamNcaInvitationNewParams) MarshalJSON() (data []byte, err error)

type OrgTeamNcaInvitationNewParamsInviteAs 

type OrgTeamNcaInvitationNewParamsInviteAs string

Nca allow users to be invited as Admin and as Member 

const (
	OrgTeamNcaInvitationNewParamsInviteAsAdmin  OrgTeamNcaInvitationNewParamsInviteAs = "ADMIN"
	OrgTeamNcaInvitationNewParamsInviteAsMember OrgTeamNcaInvitationNewParamsInviteAs = "MEMBER"
)

func (OrgTeamNcaInvitationNewParamsInviteAs) IsKnown 

func (r OrgTeamNcaInvitationNewParamsInviteAs) IsKnown() bool

type OrgTeamNcaInvitationService 

type OrgTeamNcaInvitationService struct {
	Options []option.RequestOption
}

OrgTeamNcaInvitationService contains methods and other services that help with interacting with the ngc API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewOrgTeamNcaInvitationService method instead.

func NewOrgTeamNcaInvitationService 

func NewOrgTeamNcaInvitationService(opts ...option.RequestOption) (r *OrgTeamNcaInvitationService)

NewOrgTeamNcaInvitationService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*OrgTeamNcaInvitationService) New 

func (r *OrgTeamNcaInvitationService) New(ctx context.Context, orgName string, teamName string, body OrgTeamNcaInvitationNewParams, opts ...option.RequestOption) (res *shared.User, err error)

Invites and creates a User in team

type OrgTeamService 

type OrgTeamService struct {
	Options        []option.RequestOption
	Users          *OrgTeamUserService
	StarfleetIDs   *OrgTeamStarfleetIDService
	NcaInvitations *OrgTeamNcaInvitationService
}

OrgTeamService contains methods and other services that help with interacting with the ngc API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewOrgTeamService method instead.

func NewOrgTeamService 

func NewOrgTeamService(opts ...option.RequestOption) (r *OrgTeamService)

NewOrgTeamService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*OrgTeamService) List 

func (r *OrgTeamService) List(ctx context.Context, orgName string, query OrgTeamListParams, opts ...option.RequestOption) (res *pagination.PageNumberTeams[shared.OrgTeamListResponse], err error)

List all Teams

func (*OrgTeamService) ListAutoPaging 

func (r *OrgTeamService) ListAutoPaging(ctx context.Context, orgName string, query OrgTeamListParams, opts ...option.RequestOption) *pagination.PageNumberTeamsAutoPager[shared.OrgTeamListResponse]

List all Teams

type OrgTeamStarfleetIDService 

type OrgTeamStarfleetIDService struct {
	Options []option.RequestOption
}

OrgTeamStarfleetIDService contains methods and other services that help with interacting with the ngc API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewOrgTeamStarfleetIDService method instead.

func NewOrgTeamStarfleetIDService 

func NewOrgTeamStarfleetIDService(opts ...option.RequestOption) (r *OrgTeamStarfleetIDService)

NewOrgTeamStarfleetIDService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*OrgTeamStarfleetIDService) Get 

func (r *OrgTeamStarfleetIDService) Get(ctx context.Context, orgName string, teamName string, starfleetID string, opts ...option.RequestOption) (res *shared.User, err error)

Get User details in team by starfleet Id

type OrgTeamUserAddRoleParams 

type OrgTeamUserAddRoleParams struct {
	Roles     param.Field[[]string] `query:"roles,required"`
	Ncid      param.Field[string]   `cookie:"ncid"`
	VisitorID param.Field[string]   `cookie:"VisitorID"`
}

func (OrgTeamUserAddRoleParams) URLQuery 

func (r OrgTeamUserAddRoleParams) URLQuery() (v url.Values)

URLQuery serializes OrgTeamUserAddRoleParams's query parameters as `url.Values`.

type OrgTeamUserDeleteParams 

type OrgTeamUserDeleteParams struct {
	// If anonymize is true, then org owner permission is required.
	Anonymize param.Field[bool] `query:"anonymize"`
}

func (OrgTeamUserDeleteParams) URLQuery 

func (r OrgTeamUserDeleteParams) URLQuery() (v url.Values)

URLQuery serializes OrgTeamUserDeleteParams's query parameters as `url.Values`.

type OrgTeamUserDeleteResponse 

type OrgTeamUserDeleteResponse struct {
	RequestStatus OrgTeamUserDeleteResponseRequestStatus `json:"requestStatus"`
	JSON          orgTeamUserDeleteResponseJSON          `json:"-"`
}

func (*OrgTeamUserDeleteResponse) UnmarshalJSON 

func (r *OrgTeamUserDeleteResponse) UnmarshalJSON(data []byte) (err error)

type OrgTeamUserDeleteResponseRequestStatus 

type OrgTeamUserDeleteResponseRequestStatus struct {
	RequestID string `json:"requestId"`
	ServerID  string `json:"serverId"`
	// Describes response status reported by the server.
	StatusCode        OrgTeamUserDeleteResponseRequestStatusStatusCode `json:"statusCode"`
	StatusDescription string                                           `json:"statusDescription"`
	JSON              orgTeamUserDeleteResponseRequestStatusJSON       `json:"-"`
}

func (*OrgTeamUserDeleteResponseRequestStatus) UnmarshalJSON 

func (r *OrgTeamUserDeleteResponseRequestStatus) UnmarshalJSON(data []byte) (err error)

type OrgTeamUserDeleteResponseRequestStatusStatusCode 

type OrgTeamUserDeleteResponseRequestStatusStatusCode string

Describes response status reported by the server. 

const (
	OrgTeamUserDeleteResponseRequestStatusStatusCodeUnknown                    OrgTeamUserDeleteResponseRequestStatusStatusCode = "UNKNOWN"
	OrgTeamUserDeleteResponseRequestStatusStatusCodeSuccess                    OrgTeamUserDeleteResponseRequestStatusStatusCode = "SUCCESS"
	OrgTeamUserDeleteResponseRequestStatusStatusCodeUnauthorized               OrgTeamUserDeleteResponseRequestStatusStatusCode = "UNAUTHORIZED"
	OrgTeamUserDeleteResponseRequestStatusStatusCodePaymentRequired            OrgTeamUserDeleteResponseRequestStatusStatusCode = "PAYMENT_REQUIRED"
	OrgTeamUserDeleteResponseRequestStatusStatusCodeForbidden                  OrgTeamUserDeleteResponseRequestStatusStatusCode = "FORBIDDEN"
	OrgTeamUserDeleteResponseRequestStatusStatusCodeTimeout                    OrgTeamUserDeleteResponseRequestStatusStatusCode = "TIMEOUT"
	OrgTeamUserDeleteResponseRequestStatusStatusCodeExists                     OrgTeamUserDeleteResponseRequestStatusStatusCode = "EXISTS"
	OrgTeamUserDeleteResponseRequestStatusStatusCodeNotFound                   OrgTeamUserDeleteResponseRequestStatusStatusCode = "NOT_FOUND"
	OrgTeamUserDeleteResponseRequestStatusStatusCodeInternalError              OrgTeamUserDeleteResponseRequestStatusStatusCode = "INTERNAL_ERROR"
	OrgTeamUserDeleteResponseRequestStatusStatusCodeInvalidRequest             OrgTeamUserDeleteResponseRequestStatusStatusCode = "INVALID_REQUEST"
	OrgTeamUserDeleteResponseRequestStatusStatusCodeInvalidRequestVersion      OrgTeamUserDeleteResponseRequestStatusStatusCode = "INVALID_REQUEST_VERSION"
	OrgTeamUserDeleteResponseRequestStatusStatusCodeInvalidRequestData         OrgTeamUserDeleteResponseRequestStatusStatusCode = "INVALID_REQUEST_DATA"
	OrgTeamUserDeleteResponseRequestStatusStatusCodeMethodNotAllowed           OrgTeamUserDeleteResponseRequestStatusStatusCode = "METHOD_NOT_ALLOWED"
	OrgTeamUserDeleteResponseRequestStatusStatusCodeConflict                   OrgTeamUserDeleteResponseRequestStatusStatusCode = "CONFLICT"
	OrgTeamUserDeleteResponseRequestStatusStatusCodeUnprocessableEntity        OrgTeamUserDeleteResponseRequestStatusStatusCode = "UNPROCESSABLE_ENTITY"
	OrgTeamUserDeleteResponseRequestStatusStatusCodeTooManyRequests            OrgTeamUserDeleteResponseRequestStatusStatusCode = "TOO_MANY_REQUESTS"
	OrgTeamUserDeleteResponseRequestStatusStatusCodeInsufficientStorage        OrgTeamUserDeleteResponseRequestStatusStatusCode = "INSUFFICIENT_STORAGE"
	OrgTeamUserDeleteResponseRequestStatusStatusCodeServiceUnavailable         OrgTeamUserDeleteResponseRequestStatusStatusCode = "SERVICE_UNAVAILABLE"
	OrgTeamUserDeleteResponseRequestStatusStatusCodePayloadTooLarge            OrgTeamUserDeleteResponseRequestStatusStatusCode = "PAYLOAD_TOO_LARGE"
	OrgTeamUserDeleteResponseRequestStatusStatusCodeNotAcceptable              OrgTeamUserDeleteResponseRequestStatusStatusCode = "NOT_ACCEPTABLE"
	OrgTeamUserDeleteResponseRequestStatusStatusCodeUnavailableForLegalReasons OrgTeamUserDeleteResponseRequestStatusStatusCode = "UNAVAILABLE_FOR_LEGAL_REASONS"
	OrgTeamUserDeleteResponseRequestStatusStatusCodeBadGateway                 OrgTeamUserDeleteResponseRequestStatusStatusCode = "BAD_GATEWAY"
)

func (OrgTeamUserDeleteResponseRequestStatusStatusCode) IsKnown 

func (r OrgTeamUserDeleteResponseRequestStatusStatusCode) IsKnown() bool

type OrgTeamUserInvitationDeleteResponse 

type OrgTeamUserInvitationDeleteResponse struct {
	RequestStatus OrgTeamUserInvitationDeleteResponseRequestStatus `json:"requestStatus"`
	JSON          orgTeamUserInvitationDeleteResponseJSON          `json:"-"`
}

func (*OrgTeamUserInvitationDeleteResponse) UnmarshalJSON 

func (r *OrgTeamUserInvitationDeleteResponse) UnmarshalJSON(data []byte) (err error)

type OrgTeamUserInvitationDeleteResponseRequestStatus 

type OrgTeamUserInvitationDeleteResponseRequestStatus struct {
	RequestID string `json:"requestId"`
	ServerID  string `json:"serverId"`
	// Describes response status reported by the server.
	StatusCode        OrgTeamUserInvitationDeleteResponseRequestStatusStatusCode `json:"statusCode"`
	StatusDescription string                                                     `json:"statusDescription"`
	JSON              orgTeamUserInvitationDeleteResponseRequestStatusJSON       `json:"-"`
}

func (*OrgTeamUserInvitationDeleteResponseRequestStatus) UnmarshalJSON 

func (r *OrgTeamUserInvitationDeleteResponseRequestStatus) UnmarshalJSON(data []byte) (err error)

type OrgTeamUserInvitationDeleteResponseRequestStatusStatusCode 

type OrgTeamUserInvitationDeleteResponseRequestStatusStatusCode string

Describes response status reported by the server. 

const (
	OrgTeamUserInvitationDeleteResponseRequestStatusStatusCodeUnknown                    OrgTeamUserInvitationDeleteResponseRequestStatusStatusCode = "UNKNOWN"
	OrgTeamUserInvitationDeleteResponseRequestStatusStatusCodeSuccess                    OrgTeamUserInvitationDeleteResponseRequestStatusStatusCode = "SUCCESS"
	OrgTeamUserInvitationDeleteResponseRequestStatusStatusCodeUnauthorized               OrgTeamUserInvitationDeleteResponseRequestStatusStatusCode = "UNAUTHORIZED"
	OrgTeamUserInvitationDeleteResponseRequestStatusStatusCodePaymentRequired            OrgTeamUserInvitationDeleteResponseRequestStatusStatusCode = "PAYMENT_REQUIRED"
	OrgTeamUserInvitationDeleteResponseRequestStatusStatusCodeForbidden                  OrgTeamUserInvitationDeleteResponseRequestStatusStatusCode = "FORBIDDEN"
	OrgTeamUserInvitationDeleteResponseRequestStatusStatusCodeTimeout                    OrgTeamUserInvitationDeleteResponseRequestStatusStatusCode = "TIMEOUT"
	OrgTeamUserInvitationDeleteResponseRequestStatusStatusCodeExists                     OrgTeamUserInvitationDeleteResponseRequestStatusStatusCode = "EXISTS"
	OrgTeamUserInvitationDeleteResponseRequestStatusStatusCodeNotFound                   OrgTeamUserInvitationDeleteResponseRequestStatusStatusCode = "NOT_FOUND"
	OrgTeamUserInvitationDeleteResponseRequestStatusStatusCodeInternalError              OrgTeamUserInvitationDeleteResponseRequestStatusStatusCode = "INTERNAL_ERROR"
	OrgTeamUserInvitationDeleteResponseRequestStatusStatusCodeInvalidRequest             OrgTeamUserInvitationDeleteResponseRequestStatusStatusCode = "INVALID_REQUEST"
	OrgTeamUserInvitationDeleteResponseRequestStatusStatusCodeInvalidRequestVersion      OrgTeamUserInvitationDeleteResponseRequestStatusStatusCode = "INVALID_REQUEST_VERSION"
	OrgTeamUserInvitationDeleteResponseRequestStatusStatusCodeInvalidRequestData         OrgTeamUserInvitationDeleteResponseRequestStatusStatusCode = "INVALID_REQUEST_DATA"
	OrgTeamUserInvitationDeleteResponseRequestStatusStatusCodeMethodNotAllowed           OrgTeamUserInvitationDeleteResponseRequestStatusStatusCode = "METHOD_NOT_ALLOWED"
	OrgTeamUserInvitationDeleteResponseRequestStatusStatusCodeConflict                   OrgTeamUserInvitationDeleteResponseRequestStatusStatusCode = "CONFLICT"
	OrgTeamUserInvitationDeleteResponseRequestStatusStatusCodeUnprocessableEntity        OrgTeamUserInvitationDeleteResponseRequestStatusStatusCode = "UNPROCESSABLE_ENTITY"
	OrgTeamUserInvitationDeleteResponseRequestStatusStatusCodeTooManyRequests            OrgTeamUserInvitationDeleteResponseRequestStatusStatusCode = "TOO_MANY_REQUESTS"
	OrgTeamUserInvitationDeleteResponseRequestStatusStatusCodeInsufficientStorage        OrgTeamUserInvitationDeleteResponseRequestStatusStatusCode = "INSUFFICIENT_STORAGE"
	OrgTeamUserInvitationDeleteResponseRequestStatusStatusCodeServiceUnavailable         OrgTeamUserInvitationDeleteResponseRequestStatusStatusCode = "SERVICE_UNAVAILABLE"
	OrgTeamUserInvitationDeleteResponseRequestStatusStatusCodePayloadTooLarge            OrgTeamUserInvitationDeleteResponseRequestStatusStatusCode = "PAYLOAD_TOO_LARGE"
	OrgTeamUserInvitationDeleteResponseRequestStatusStatusCodeNotAcceptable              OrgTeamUserInvitationDeleteResponseRequestStatusStatusCode = "NOT_ACCEPTABLE"
	OrgTeamUserInvitationDeleteResponseRequestStatusStatusCodeUnavailableForLegalReasons OrgTeamUserInvitationDeleteResponseRequestStatusStatusCode = "UNAVAILABLE_FOR_LEGAL_REASONS"
	OrgTeamUserInvitationDeleteResponseRequestStatusStatusCodeBadGateway                 OrgTeamUserInvitationDeleteResponseRequestStatusStatusCode = "BAD_GATEWAY"
)

func (OrgTeamUserInvitationDeleteResponseRequestStatusStatusCode) IsKnown 

func (r OrgTeamUserInvitationDeleteResponseRequestStatusStatusCode) IsKnown() bool

type OrgTeamUserInvitationListParams 

type OrgTeamUserInvitationListParams struct {
	OrderBy param.Field[OrgTeamUserInvitationListParamsOrderBy] `query:"orderBy"`
	// The page number of result
	PageNumber param.Field[int64] `query:"page-number"`
	// The page size of result
	PageSize param.Field[int64] `query:"page-size"`
	// User Search Parameters
	Q param.Field[OrgTeamUserInvitationListParamsQ] `query:"q"`
}

func (OrgTeamUserInvitationListParams) URLQuery 

func (r OrgTeamUserInvitationListParams) URLQuery() (v url.Values)

URLQuery serializes OrgTeamUserInvitationListParams's query parameters as `url.Values`.

type OrgTeamUserInvitationListParamsOrderBy 

type OrgTeamUserInvitationListParamsOrderBy string
const (
	OrgTeamUserInvitationListParamsOrderByNameAsc  OrgTeamUserInvitationListParamsOrderBy = "NAME_ASC"
	OrgTeamUserInvitationListParamsOrderByNameDesc OrgTeamUserInvitationListParamsOrderBy = "NAME_DESC"
)

func (OrgTeamUserInvitationListParamsOrderBy) IsKnown 

func (r OrgTeamUserInvitationListParamsOrderBy) IsKnown() bool

type OrgTeamUserInvitationListParamsQ 

type OrgTeamUserInvitationListParamsQ struct {
	Fields      param.Field[[]string]                                  `query:"fields"`
	Filters     param.Field[[]OrgTeamUserInvitationListParamsQFilter]  `query:"filters"`
	GroupBy     param.Field[string]                                    `query:"groupBy"`
	OrderBy     param.Field[[]OrgTeamUserInvitationListParamsQOrderBy] `query:"orderBy"`
	Page        param.Field[int64]                                     `query:"page"`
	PageSize    param.Field[int64]                                     `query:"pageSize"`
	Query       param.Field[string]                                    `query:"query"`
	QueryFields param.Field[[]string]                                  `query:"queryFields"`
	ScoredSize  param.Field[int64]                                     `query:"scoredSize"`
}

User Search Parameters

func (OrgTeamUserInvitationListParamsQ) URLQuery 

func (r OrgTeamUserInvitationListParamsQ) URLQuery() (v url.Values)

URLQuery serializes OrgTeamUserInvitationListParamsQ's query parameters as `url.Values`.

type OrgTeamUserInvitationListParamsQFilter 

type OrgTeamUserInvitationListParamsQFilter struct {
	Field param.Field[string] `query:"field"`
	Value param.Field[string] `query:"value"`
}

func (OrgTeamUserInvitationListParamsQFilter) URLQuery 

func (r OrgTeamUserInvitationListParamsQFilter) URLQuery() (v url.Values)

URLQuery serializes OrgTeamUserInvitationListParamsQFilter's query parameters as `url.Values`.

type OrgTeamUserInvitationListParamsQOrderBy 

type OrgTeamUserInvitationListParamsQOrderBy struct {
	Field param.Field[string]                                       `query:"field"`
	Value param.Field[OrgTeamUserInvitationListParamsQOrderByValue] `query:"value"`
}

func (OrgTeamUserInvitationListParamsQOrderBy) URLQuery 

func (r OrgTeamUserInvitationListParamsQOrderBy) URLQuery() (v url.Values)

URLQuery serializes OrgTeamUserInvitationListParamsQOrderBy's query parameters as `url.Values`.

type OrgTeamUserInvitationListParamsQOrderByValue 

type OrgTeamUserInvitationListParamsQOrderByValue string
const (
	OrgTeamUserInvitationListParamsQOrderByValueAsc  OrgTeamUserInvitationListParamsQOrderByValue = "ASC"
	OrgTeamUserInvitationListParamsQOrderByValueDesc OrgTeamUserInvitationListParamsQOrderByValue = "DESC"
)

func (OrgTeamUserInvitationListParamsQOrderByValue) IsKnown 

func (r OrgTeamUserInvitationListParamsQOrderByValue) IsKnown() bool

type OrgTeamUserInvitationListResponse 

type OrgTeamUserInvitationListResponse struct {
	// Unique invitation ID
	ID string `json:"id"`
	// Date on which the invitation was created. (ISO-8601 format)
	CreatedDate string `json:"createdDate"`
	// Email address of the user.
	Email string `json:"email"`
	// Flag indicating if the invitation has already been accepted by the user.
	IsProcessed bool `json:"isProcessed"`
	// user name
	Name string `json:"name"`
	// Org to which a user was invited.
	Org string `json:"org"`
	// List of roles that the user have.
	Roles []string `json:"roles"`
	// Team to which a user was invited.
	Team string `json:"team"`
	// Type of invitation. The invitation is either to an organization or to a team
	// within organization.
	Type OrgTeamUserInvitationListResponseType `json:"type"`
	JSON orgTeamUserInvitationListResponseJSON `json:"-"`
}

User invitation to an NGC org or team

func (*OrgTeamUserInvitationListResponse) UnmarshalJSON 

func (r *OrgTeamUserInvitationListResponse) UnmarshalJSON(data []byte) (err error)

type OrgTeamUserInvitationListResponseType 

type OrgTeamUserInvitationListResponseType string

Type of invitation. The invitation is either to an organization or to a team within organization. 

const (
	OrgTeamUserInvitationListResponseTypeOrganization OrgTeamUserInvitationListResponseType = "ORGANIZATION"
	OrgTeamUserInvitationListResponseTypeTeam         OrgTeamUserInvitationListResponseType = "TEAM"
)

func (OrgTeamUserInvitationListResponseType) IsKnown 

func (r OrgTeamUserInvitationListResponseType) IsKnown() bool

type OrgTeamUserInvitationService 

type OrgTeamUserInvitationService struct {
	Options []option.RequestOption
}

OrgTeamUserInvitationService contains methods and other services that help with interacting with the ngc API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewOrgTeamUserInvitationService method instead.

func NewOrgTeamUserInvitationService 

func NewOrgTeamUserInvitationService(opts ...option.RequestOption) (r *OrgTeamUserInvitationService)

NewOrgTeamUserInvitationService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*OrgTeamUserInvitationService) Delete 

func (r *OrgTeamUserInvitationService) Delete(ctx context.Context, orgName string, teamName string, id string, opts ...option.RequestOption) (res *OrgTeamUserInvitationDeleteResponse, err error)

Delete a specific invitation in an team. (Org Admin or Team User Admin privileges required)

func (*OrgTeamUserInvitationService) InviteResend 

func (r *OrgTeamUserInvitationService) InviteResend(ctx context.Context, orgName string, teamName string, id string, opts ...option.RequestOption) (res *shared.User, err error)

Resend email of a specific invitation in a team (Org or Team User Admin privileges required).

func (*OrgTeamUserInvitationService) List 

func (r *OrgTeamUserInvitationService) List(ctx context.Context, orgName string, teamName string, query OrgTeamUserInvitationListParams, opts ...option.RequestOption) (res *pagination.PageNumberInvitations[shared.OrgTeamUserInvitationListResponse], err error)

List invitations in a team. (Team User Admin privileges required)

func (*OrgTeamUserInvitationService) ListAutoPaging 

func (r *OrgTeamUserInvitationService) ListAutoPaging(ctx context.Context, orgName string, teamName string, query OrgTeamUserInvitationListParams, opts ...option.RequestOption) *pagination.PageNumberInvitationsAutoPager[shared.OrgTeamUserInvitationListResponse]

List invitations in a team. (Team User Admin privileges required)

type OrgTeamUserRemoveRoleParams 

type OrgTeamUserRemoveRoleParams struct {
	Roles param.Field[[]string] `query:"roles"`
}

func (OrgTeamUserRemoveRoleParams) URLQuery 

func (r OrgTeamUserRemoveRoleParams) URLQuery() (v url.Values)

URLQuery serializes OrgTeamUserRemoveRoleParams's query parameters as `url.Values`.

type OrgTeamUserService 

type OrgTeamUserService struct {
	Options []option.RequestOption
}

OrgTeamUserService contains methods and other services that help with interacting with the ngc API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewOrgTeamUserService method instead.

func NewOrgTeamUserService 

func NewOrgTeamUserService(opts ...option.RequestOption) (r *OrgTeamUserService)

NewOrgTeamUserService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*OrgTeamUserService) AddRole 

func (r *OrgTeamUserService) AddRole(ctx context.Context, orgName string, teamName string, userEmailOrID string, params OrgTeamUserAddRoleParams, opts ...option.RequestOption) (res *shared.User, err error)

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

func (*OrgTeamUserService) Delete 

func (r *OrgTeamUserService) Delete(ctx context.Context, orgName string, teamName string, id string, body OrgTeamUserDeleteParams, opts ...option.RequestOption) (res *OrgTeamUserDeleteResponse, err error)

Remove User from team.

func (*OrgTeamUserService) RemoveRole 

func (r *OrgTeamUserService) RemoveRole(ctx context.Context, orgName string, teamName string, userEmailOrID string, body OrgTeamUserRemoveRoleParams, opts ...option.RequestOption) (res *shared.User, err error)

Remove role in team if user exists, otherwise remove invitation

type OrgUpdateParams 

type OrgUpdateParams struct {
	// optional description of the organization
	Description param.Field[string] `json:"description"`
	// Name of the organization that will be shown to users
	DisplayName param.Field[string] `json:"displayName"`
}

func (OrgUpdateParams) MarshalJSON 

func (r OrgUpdateParams) MarshalJSON() (data []byte, err error)

type OrgUserAddRoleParams 

type OrgUserAddRoleParams struct {
	Roles     param.Field[[]string] `query:"roles,required"`
	Ncid      param.Field[string]   `cookie:"ncid"`
	VisitorID param.Field[string]   `cookie:"VisitorID"`
}

func (OrgUserAddRoleParams) URLQuery 

func (r OrgUserAddRoleParams) URLQuery() (v url.Values)

URLQuery serializes OrgUserAddRoleParams's query parameters as `url.Values`.

type OrgUserDeleteParams 

type OrgUserDeleteParams struct {
	// If anonymize is true, then org owner permission is required.
	Anonymize param.Field[bool] `query:"anonymize"`
}

func (OrgUserDeleteParams) URLQuery 

func (r OrgUserDeleteParams) URLQuery() (v url.Values)

URLQuery serializes OrgUserDeleteParams's query parameters as `url.Values`.

type OrgUserDeleteResponse 

type OrgUserDeleteResponse struct {
	RequestStatus OrgUserDeleteResponseRequestStatus `json:"requestStatus"`
	JSON          orgUserDeleteResponseJSON          `json:"-"`
}

func (*OrgUserDeleteResponse) UnmarshalJSON 

func (r *OrgUserDeleteResponse) UnmarshalJSON(data []byte) (err error)

type OrgUserDeleteResponseRequestStatus 

type OrgUserDeleteResponseRequestStatus struct {
	RequestID string `json:"requestId"`
	ServerID  string `json:"serverId"`
	// Describes response status reported by the server.
	StatusCode        OrgUserDeleteResponseRequestStatusStatusCode `json:"statusCode"`
	StatusDescription string                                       `json:"statusDescription"`
	JSON              orgUserDeleteResponseRequestStatusJSON       `json:"-"`
}

func (*OrgUserDeleteResponseRequestStatus) UnmarshalJSON 

func (r *OrgUserDeleteResponseRequestStatus) UnmarshalJSON(data []byte) (err error)

type OrgUserDeleteResponseRequestStatusStatusCode 

type OrgUserDeleteResponseRequestStatusStatusCode string

Describes response status reported by the server. 

const (
	OrgUserDeleteResponseRequestStatusStatusCodeUnknown                    OrgUserDeleteResponseRequestStatusStatusCode = "UNKNOWN"
	OrgUserDeleteResponseRequestStatusStatusCodeSuccess                    OrgUserDeleteResponseRequestStatusStatusCode = "SUCCESS"
	OrgUserDeleteResponseRequestStatusStatusCodeUnauthorized               OrgUserDeleteResponseRequestStatusStatusCode = "UNAUTHORIZED"
	OrgUserDeleteResponseRequestStatusStatusCodePaymentRequired            OrgUserDeleteResponseRequestStatusStatusCode = "PAYMENT_REQUIRED"
	OrgUserDeleteResponseRequestStatusStatusCodeForbidden                  OrgUserDeleteResponseRequestStatusStatusCode = "FORBIDDEN"
	OrgUserDeleteResponseRequestStatusStatusCodeTimeout                    OrgUserDeleteResponseRequestStatusStatusCode = "TIMEOUT"
	OrgUserDeleteResponseRequestStatusStatusCodeExists                     OrgUserDeleteResponseRequestStatusStatusCode = "EXISTS"
	OrgUserDeleteResponseRequestStatusStatusCodeNotFound                   OrgUserDeleteResponseRequestStatusStatusCode = "NOT_FOUND"
	OrgUserDeleteResponseRequestStatusStatusCodeInternalError              OrgUserDeleteResponseRequestStatusStatusCode = "INTERNAL_ERROR"
	OrgUserDeleteResponseRequestStatusStatusCodeInvalidRequest             OrgUserDeleteResponseRequestStatusStatusCode = "INVALID_REQUEST"
	OrgUserDeleteResponseRequestStatusStatusCodeInvalidRequestVersion      OrgUserDeleteResponseRequestStatusStatusCode = "INVALID_REQUEST_VERSION"
	OrgUserDeleteResponseRequestStatusStatusCodeInvalidRequestData         OrgUserDeleteResponseRequestStatusStatusCode = "INVALID_REQUEST_DATA"
	OrgUserDeleteResponseRequestStatusStatusCodeMethodNotAllowed           OrgUserDeleteResponseRequestStatusStatusCode = "METHOD_NOT_ALLOWED"
	OrgUserDeleteResponseRequestStatusStatusCodeConflict                   OrgUserDeleteResponseRequestStatusStatusCode = "CONFLICT"
	OrgUserDeleteResponseRequestStatusStatusCodeUnprocessableEntity        OrgUserDeleteResponseRequestStatusStatusCode = "UNPROCESSABLE_ENTITY"
	OrgUserDeleteResponseRequestStatusStatusCodeTooManyRequests            OrgUserDeleteResponseRequestStatusStatusCode = "TOO_MANY_REQUESTS"
	OrgUserDeleteResponseRequestStatusStatusCodeInsufficientStorage        OrgUserDeleteResponseRequestStatusStatusCode = "INSUFFICIENT_STORAGE"
	OrgUserDeleteResponseRequestStatusStatusCodeServiceUnavailable         OrgUserDeleteResponseRequestStatusStatusCode = "SERVICE_UNAVAILABLE"
	OrgUserDeleteResponseRequestStatusStatusCodePayloadTooLarge            OrgUserDeleteResponseRequestStatusStatusCode = "PAYLOAD_TOO_LARGE"
	OrgUserDeleteResponseRequestStatusStatusCodeNotAcceptable              OrgUserDeleteResponseRequestStatusStatusCode = "NOT_ACCEPTABLE"
	OrgUserDeleteResponseRequestStatusStatusCodeUnavailableForLegalReasons OrgUserDeleteResponseRequestStatusStatusCode = "UNAVAILABLE_FOR_LEGAL_REASONS"
	OrgUserDeleteResponseRequestStatusStatusCodeBadGateway                 OrgUserDeleteResponseRequestStatusStatusCode = "BAD_GATEWAY"
)

func (OrgUserDeleteResponseRequestStatusStatusCode) IsKnown 

func (r OrgUserDeleteResponseRequestStatusStatusCode) IsKnown() bool

type OrgUserInvitationDeleteResponse 

type OrgUserInvitationDeleteResponse struct {
	RequestStatus OrgUserInvitationDeleteResponseRequestStatus `json:"requestStatus"`
	JSON          orgUserInvitationDeleteResponseJSON          `json:"-"`
}

func (*OrgUserInvitationDeleteResponse) UnmarshalJSON 

func (r *OrgUserInvitationDeleteResponse) UnmarshalJSON(data []byte) (err error)

type OrgUserInvitationDeleteResponseRequestStatus 

type OrgUserInvitationDeleteResponseRequestStatus struct {
	RequestID string `json:"requestId"`
	ServerID  string `json:"serverId"`
	// Describes response status reported by the server.
	StatusCode        OrgUserInvitationDeleteResponseRequestStatusStatusCode `json:"statusCode"`
	StatusDescription string                                                 `json:"statusDescription"`
	JSON              orgUserInvitationDeleteResponseRequestStatusJSON       `json:"-"`
}

func (*OrgUserInvitationDeleteResponseRequestStatus) UnmarshalJSON 

func (r *OrgUserInvitationDeleteResponseRequestStatus) UnmarshalJSON(data []byte) (err error)

type OrgUserInvitationDeleteResponseRequestStatusStatusCode 

type OrgUserInvitationDeleteResponseRequestStatusStatusCode string

Describes response status reported by the server. 

const (
	OrgUserInvitationDeleteResponseRequestStatusStatusCodeUnknown                    OrgUserInvitationDeleteResponseRequestStatusStatusCode = "UNKNOWN"
	OrgUserInvitationDeleteResponseRequestStatusStatusCodeSuccess                    OrgUserInvitationDeleteResponseRequestStatusStatusCode = "SUCCESS"
	OrgUserInvitationDeleteResponseRequestStatusStatusCodeUnauthorized               OrgUserInvitationDeleteResponseRequestStatusStatusCode = "UNAUTHORIZED"
	OrgUserInvitationDeleteResponseRequestStatusStatusCodePaymentRequired            OrgUserInvitationDeleteResponseRequestStatusStatusCode = "PAYMENT_REQUIRED"
	OrgUserInvitationDeleteResponseRequestStatusStatusCodeForbidden                  OrgUserInvitationDeleteResponseRequestStatusStatusCode = "FORBIDDEN"
	OrgUserInvitationDeleteResponseRequestStatusStatusCodeTimeout                    OrgUserInvitationDeleteResponseRequestStatusStatusCode = "TIMEOUT"
	OrgUserInvitationDeleteResponseRequestStatusStatusCodeExists                     OrgUserInvitationDeleteResponseRequestStatusStatusCode = "EXISTS"
	OrgUserInvitationDeleteResponseRequestStatusStatusCodeNotFound                   OrgUserInvitationDeleteResponseRequestStatusStatusCode = "NOT_FOUND"
	OrgUserInvitationDeleteResponseRequestStatusStatusCodeInternalError              OrgUserInvitationDeleteResponseRequestStatusStatusCode = "INTERNAL_ERROR"
	OrgUserInvitationDeleteResponseRequestStatusStatusCodeInvalidRequest             OrgUserInvitationDeleteResponseRequestStatusStatusCode = "INVALID_REQUEST"
	OrgUserInvitationDeleteResponseRequestStatusStatusCodeInvalidRequestVersion      OrgUserInvitationDeleteResponseRequestStatusStatusCode = "INVALID_REQUEST_VERSION"
	OrgUserInvitationDeleteResponseRequestStatusStatusCodeInvalidRequestData         OrgUserInvitationDeleteResponseRequestStatusStatusCode = "INVALID_REQUEST_DATA"
	OrgUserInvitationDeleteResponseRequestStatusStatusCodeMethodNotAllowed           OrgUserInvitationDeleteResponseRequestStatusStatusCode = "METHOD_NOT_ALLOWED"
	OrgUserInvitationDeleteResponseRequestStatusStatusCodeConflict                   OrgUserInvitationDeleteResponseRequestStatusStatusCode = "CONFLICT"
	OrgUserInvitationDeleteResponseRequestStatusStatusCodeUnprocessableEntity        OrgUserInvitationDeleteResponseRequestStatusStatusCode = "UNPROCESSABLE_ENTITY"
	OrgUserInvitationDeleteResponseRequestStatusStatusCodeTooManyRequests            OrgUserInvitationDeleteResponseRequestStatusStatusCode = "TOO_MANY_REQUESTS"
	OrgUserInvitationDeleteResponseRequestStatusStatusCodeInsufficientStorage        OrgUserInvitationDeleteResponseRequestStatusStatusCode = "INSUFFICIENT_STORAGE"
	OrgUserInvitationDeleteResponseRequestStatusStatusCodeServiceUnavailable         OrgUserInvitationDeleteResponseRequestStatusStatusCode = "SERVICE_UNAVAILABLE"
	OrgUserInvitationDeleteResponseRequestStatusStatusCodePayloadTooLarge            OrgUserInvitationDeleteResponseRequestStatusStatusCode = "PAYLOAD_TOO_LARGE"
	OrgUserInvitationDeleteResponseRequestStatusStatusCodeNotAcceptable              OrgUserInvitationDeleteResponseRequestStatusStatusCode = "NOT_ACCEPTABLE"
	OrgUserInvitationDeleteResponseRequestStatusStatusCodeUnavailableForLegalReasons OrgUserInvitationDeleteResponseRequestStatusStatusCode = "UNAVAILABLE_FOR_LEGAL_REASONS"
	OrgUserInvitationDeleteResponseRequestStatusStatusCodeBadGateway                 OrgUserInvitationDeleteResponseRequestStatusStatusCode = "BAD_GATEWAY"
)

func (OrgUserInvitationDeleteResponseRequestStatusStatusCode) IsKnown 

func (r OrgUserInvitationDeleteResponseRequestStatusStatusCode) IsKnown() bool

type OrgUserInvitationListParams 

type OrgUserInvitationListParams struct {
	OrderBy param.Field[OrgUserInvitationListParamsOrderBy] `query:"orderBy"`
	// The page number of result
	PageNumber param.Field[int64] `query:"page-number"`
	// The page size of result
	PageSize param.Field[int64] `query:"page-size"`
	// User Search Parameters
	Q param.Field[OrgUserInvitationListParamsQ] `query:"q"`
}

func (OrgUserInvitationListParams) URLQuery 

func (r OrgUserInvitationListParams) URLQuery() (v url.Values)

URLQuery serializes OrgUserInvitationListParams's query parameters as `url.Values`.

type OrgUserInvitationListParamsOrderBy 

type OrgUserInvitationListParamsOrderBy string
const (
	OrgUserInvitationListParamsOrderByNameAsc  OrgUserInvitationListParamsOrderBy = "NAME_ASC"
	OrgUserInvitationListParamsOrderByNameDesc OrgUserInvitationListParamsOrderBy = "NAME_DESC"
)

func (OrgUserInvitationListParamsOrderBy) IsKnown 

func (r OrgUserInvitationListParamsOrderBy) IsKnown() bool

type OrgUserInvitationListParamsQ 

type OrgUserInvitationListParamsQ struct {
	Fields      param.Field[[]string]                              `query:"fields"`
	Filters     param.Field[[]OrgUserInvitationListParamsQFilter]  `query:"filters"`
	GroupBy     param.Field[string]                                `query:"groupBy"`
	OrderBy     param.Field[[]OrgUserInvitationListParamsQOrderBy] `query:"orderBy"`
	Page        param.Field[int64]                                 `query:"page"`
	PageSize    param.Field[int64]                                 `query:"pageSize"`
	Query       param.Field[string]                                `query:"query"`
	QueryFields param.Field[[]string]                              `query:"queryFields"`
	ScoredSize  param.Field[int64]                                 `query:"scoredSize"`
}

User Search Parameters

func (OrgUserInvitationListParamsQ) URLQuery 

func (r OrgUserInvitationListParamsQ) URLQuery() (v url.Values)

URLQuery serializes OrgUserInvitationListParamsQ's query parameters as `url.Values`.

type OrgUserInvitationListParamsQFilter 

type OrgUserInvitationListParamsQFilter struct {
	Field param.Field[string] `query:"field"`
	Value param.Field[string] `query:"value"`
}

func (OrgUserInvitationListParamsQFilter) URLQuery 

func (r OrgUserInvitationListParamsQFilter) URLQuery() (v url.Values)

URLQuery serializes OrgUserInvitationListParamsQFilter's query parameters as `url.Values`.

type OrgUserInvitationListParamsQOrderBy 

type OrgUserInvitationListParamsQOrderBy struct {
	Field param.Field[string]                                   `query:"field"`
	Value param.Field[OrgUserInvitationListParamsQOrderByValue] `query:"value"`
}

func (OrgUserInvitationListParamsQOrderBy) URLQuery 

func (r OrgUserInvitationListParamsQOrderBy) URLQuery() (v url.Values)

URLQuery serializes OrgUserInvitationListParamsQOrderBy's query parameters as `url.Values`.

type OrgUserInvitationListParamsQOrderByValue 

type OrgUserInvitationListParamsQOrderByValue string
const (
	OrgUserInvitationListParamsQOrderByValueAsc  OrgUserInvitationListParamsQOrderByValue = "ASC"
	OrgUserInvitationListParamsQOrderByValueDesc OrgUserInvitationListParamsQOrderByValue = "DESC"
)

func (OrgUserInvitationListParamsQOrderByValue) IsKnown 

func (r OrgUserInvitationListParamsQOrderByValue) IsKnown() bool

type OrgUserInvitationListResponse 

type OrgUserInvitationListResponse struct {
	// Unique invitation ID
	ID string `json:"id"`
	// Date on which the invitation was created. (ISO-8601 format)
	CreatedDate string `json:"createdDate"`
	// Email address of the user.
	Email string `json:"email"`
	// Flag indicating if the invitation has already been accepted by the user.
	IsProcessed bool `json:"isProcessed"`
	// user name
	Name string `json:"name"`
	// Org to which a user was invited.
	Org string `json:"org"`
	// List of roles that the user have.
	Roles []string `json:"roles"`
	// Team to which a user was invited.
	Team string `json:"team"`
	// Type of invitation. The invitation is either to an organization or to a team
	// within organization.
	Type OrgUserInvitationListResponseType `json:"type"`
	JSON orgUserInvitationListResponseJSON `json:"-"`
}

User invitation to an NGC org or team

func (*OrgUserInvitationListResponse) UnmarshalJSON 

func (r *OrgUserInvitationListResponse) UnmarshalJSON(data []byte) (err error)

type OrgUserInvitationListResponseType 

type OrgUserInvitationListResponseType string

Type of invitation. The invitation is either to an organization or to a team within organization. 

const (
	OrgUserInvitationListResponseTypeOrganization OrgUserInvitationListResponseType = "ORGANIZATION"
	OrgUserInvitationListResponseTypeTeam         OrgUserInvitationListResponseType = "TEAM"
)

func (OrgUserInvitationListResponseType) IsKnown 

func (r OrgUserInvitationListResponseType) IsKnown() bool

type OrgUserInvitationService 

type OrgUserInvitationService struct {
	Options []option.RequestOption
}

OrgUserInvitationService contains methods and other services that help with interacting with the ngc API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewOrgUserInvitationService method instead.

func NewOrgUserInvitationService 

func NewOrgUserInvitationService(opts ...option.RequestOption) (r *OrgUserInvitationService)

NewOrgUserInvitationService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*OrgUserInvitationService) Delete 

func (r *OrgUserInvitationService) Delete(ctx context.Context, orgName string, id string, opts ...option.RequestOption) (res *OrgUserInvitationDeleteResponse, err error)

Delete a specific invitation in an org. (Org User Admin privileges required)

func (*OrgUserInvitationService) InviteResend 

func (r *OrgUserInvitationService) InviteResend(ctx context.Context, orgName string, id string, opts ...option.RequestOption) (res *shared.User, err error)

Resend email of a specific invitation in an org (Org User Admin privileges required).

func (*OrgUserInvitationService) List 

func (r *OrgUserInvitationService) List(ctx context.Context, orgName string, query OrgUserInvitationListParams, opts ...option.RequestOption) (res *pagination.PageNumberInvitations[shared.OrgUserInvitationListResponse], err error)

List invitations in an org. (Org User Admin privileges required)

func (*OrgUserInvitationService) ListAutoPaging 

func (r *OrgUserInvitationService) ListAutoPaging(ctx context.Context, orgName string, query OrgUserInvitationListParams, opts ...option.RequestOption) *pagination.PageNumberInvitationsAutoPager[shared.OrgUserInvitationListResponse]

List invitations in an org. (Org User Admin privileges required)

type OrgUserListParams 

type OrgUserListParams struct {
	// Name of team to exclude members from
	ExcludeFromTeam param.Field[string] `query:"exclude-from-team"`
	// The page number of result
	PageNumber param.Field[int64] `query:"page-number"`
	// The page size of result
	PageSize param.Field[int64] `query:"page-size"`
	// User Search Parameters. Only 'filters' and 'orderBy' for 'name' and 'email' are
	// implemented
	Q param.Field[OrgUserListParamsQ] `query:"q"`
}

func (OrgUserListParams) URLQuery 

func (r OrgUserListParams) URLQuery() (v url.Values)

URLQuery serializes OrgUserListParams's query parameters as `url.Values`.

type OrgUserListParamsQ 

type OrgUserListParamsQ struct {
	Fields      param.Field[[]string]                    `query:"fields"`
	Filters     param.Field[[]OrgUserListParamsQFilter]  `query:"filters"`
	GroupBy     param.Field[string]                      `query:"groupBy"`
	OrderBy     param.Field[[]OrgUserListParamsQOrderBy] `query:"orderBy"`
	Page        param.Field[int64]                       `query:"page"`
	PageSize    param.Field[int64]                       `query:"pageSize"`
	Query       param.Field[string]                      `query:"query"`
	QueryFields param.Field[[]string]                    `query:"queryFields"`
	ScoredSize  param.Field[int64]                       `query:"scoredSize"`
}

User Search Parameters. Only 'filters' and 'orderBy' for 'name' and 'email' are implemented

func (OrgUserListParamsQ) URLQuery 

func (r OrgUserListParamsQ) URLQuery() (v url.Values)

URLQuery serializes OrgUserListParamsQ's query parameters as `url.Values`.

type OrgUserListParamsQFilter 

type OrgUserListParamsQFilter struct {
	Field param.Field[string] `query:"field"`
	Value param.Field[string] `query:"value"`
}

func (OrgUserListParamsQFilter) URLQuery 

func (r OrgUserListParamsQFilter) URLQuery() (v url.Values)

URLQuery serializes OrgUserListParamsQFilter's query parameters as `url.Values`.

type OrgUserListParamsQOrderBy 

type OrgUserListParamsQOrderBy struct {
	Field param.Field[string]                         `query:"field"`
	Value param.Field[OrgUserListParamsQOrderByValue] `query:"value"`
}

func (OrgUserListParamsQOrderBy) URLQuery 

func (r OrgUserListParamsQOrderBy) URLQuery() (v url.Values)

URLQuery serializes OrgUserListParamsQOrderBy's query parameters as `url.Values`.

type OrgUserListParamsQOrderByValue 

type OrgUserListParamsQOrderByValue string
const (
	OrgUserListParamsQOrderByValueAsc  OrgUserListParamsQOrderByValue = "ASC"
	OrgUserListParamsQOrderByValueDesc OrgUserListParamsQOrderByValue = "DESC"
)

func (OrgUserListParamsQOrderByValue) IsKnown 

func (r OrgUserListParamsQOrderByValue) IsKnown() bool

type OrgUserListResponse 

type OrgUserListResponse struct {
	// unique Id of this user.
	ID int64 `json:"id"`
	// unique auth client id of this user.
	ClientID string `json:"clientId"`
	// Created date for this user
	CreatedDate string `json:"createdDate"`
	// Email address of the user. This should be unique.
	Email string `json:"email"`
	// Last time the user logged in
	FirstLoginDate string `json:"firstLoginDate"`
	// Determines if the user has beta access
	HasBetaAccess bool `json:"hasBetaAccess"`
	// indicate if user profile has been completed.
	HasProfile bool `json:"hasProfile"`
	// indicates if user has accepted AI Foundry Partnerships eula
	HasSignedAIFoundryPartnershipsEula bool `json:"hasSignedAiFoundryPartnershipsEULA"`
	// indicates if user has accepted Base Command End User License Agreement.
	HasSignedBaseCommandEula bool `json:"hasSignedBaseCommandEULA"`
	// indicates if user has accepted Base Command Manager End User License Agreement.
	HasSignedBaseCommandManagerEula bool `json:"hasSignedBaseCommandManagerEULA"`
	// indicates if user has accepted BioNeMo End User License Agreement.
	HasSignedBioNeMoEula bool `json:"hasSignedBioNeMoEULA"`
	// indicates if user has accepted container publishing eula
	HasSignedContainerPublishingEula bool `json:"hasSignedContainerPublishingEULA"`
	// indicates if user has accepted CuOpt eula
	HasSignedCuOptEula bool `json:"hasSignedCuOptEULA"`
	// indicates if user has accepted Earth-2 eula
	HasSignedEarth2Eula bool `json:"hasSignedEarth2EULA"`
	// [Deprecated] indicates if user has accepted EGX End User License Agreement.
	HasSignedEgxEula bool `json:"hasSignedEgxEULA"`
	// Determines if the user has signed the NGC End User License Agreement.
	HasSignedEula bool `json:"hasSignedEULA"`
	// indicates if user has accepted Fleet Command End User License Agreement.
	HasSignedFleetCommandEula bool `json:"hasSignedFleetCommandEULA"`
	// indicates if user has accepted LLM End User License Agreement.
	HasSignedLlmEula bool `json:"hasSignedLlmEULA"`
	// indicates if user has accepted Fleet Command End User License Agreement.
	HasSignedNvaieeula bool `json:"hasSignedNVAIEEULA"`
	// Determines if the user has signed the NVIDIA End User License Agreement.
	HasSignedNvidiaEula bool `json:"hasSignedNvidiaEULA"`
	// indicates if user has accepted Nvidia Quantum Cloud End User License Agreement.
	HasSignedNvqceula bool `json:"hasSignedNVQCEULA"`
	// indicates if user has accepted Omniverse End User License Agreement.
	HasSignedOmniverseEula bool `json:"hasSignedOmniverseEULA"`
	// Determines if the user has signed the Privacy Policy.
	HasSignedPrivacyPolicy bool `json:"hasSignedPrivacyPolicy"`
	// indicates if user has consented to share their registration info with other
	// parties
	HasSignedThirdPartyRegistryShareEula bool `json:"hasSignedThirdPartyRegistryShareEULA"`
	// Determines if the user has opted in email subscription.
	HasSubscribedToEmail bool `json:"hasSubscribedToEmail"`
	// Type of IDP, Identity Provider. Used for login.
	IdpType OrgUserListResponseIdpType `json:"idpType"`
	// Determines if the user is active or not.
	IsActive bool `json:"isActive"`
	// Indicates if user was deleted from the system.
	IsDeleted bool `json:"isDeleted"`
	// Determines if the user is a SAML account or not.
	IsSAML bool `json:"isSAML"`
	// Title of user's job position.
	JobPositionTitle string `json:"jobPositionTitle"`
	// Last time the user logged in
	LastLoginDate string `json:"lastLoginDate"`
	// user name
	Name string `json:"name"`
	// List of roles that the user have
	Roles []OrgUserListResponseRole `json:"roles"`
	// unique starfleet id of this user.
	StarfleetID string `json:"starfleetId"`
	// Storage quota for this user.
	StorageQuota []OrgUserListResponseStorageQuota `json:"storageQuota"`
	// Updated date for this user
	UpdatedDate string `json:"updatedDate"`
	// Metadata information about the user.
	UserMetadata OrgUserListResponseUserMetadata `json:"userMetadata"`
	JSON         orgUserListResponseJSON         `json:"-"`
}

information about the user

func (*OrgUserListResponse) UnmarshalJSON 

func (r *OrgUserListResponse) UnmarshalJSON(data []byte) (err error)

type OrgUserListResponseIdpType 

type OrgUserListResponseIdpType string

Type of IDP, Identity Provider. Used for login. 

const (
	OrgUserListResponseIdpTypeNvidia     OrgUserListResponseIdpType = "NVIDIA"
	OrgUserListResponseIdpTypeEnterprise OrgUserListResponseIdpType = "ENTERPRISE"
)

func (OrgUserListResponseIdpType) IsKnown 

func (r OrgUserListResponseIdpType) IsKnown() bool

type OrgUserListResponseRole 

type OrgUserListResponseRole struct {
	// Information about the Organization
	Org OrgUserListResponseRolesOrg `json:"org"`
	// List of org role types that the user have
	OrgRoles []string `json:"orgRoles"`
	// DEPRECATED - List of role types that the user have
	RoleTypes []string `json:"roleTypes"`
	// Information about the user who is attempting to run the job
	TargetSystemUserIdentifier OrgUserListResponseRolesTargetSystemUserIdentifier `json:"targetSystemUserIdentifier"`
	// Information about the team
	Team OrgUserListResponseRolesTeam `json:"team"`
	// List of team role types that the user have
	TeamRoles []string                    `json:"teamRoles"`
	JSON      orgUserListResponseRoleJSON `json:"-"`
}

List of roles that the user have

func (*OrgUserListResponseRole) UnmarshalJSON 

func (r *OrgUserListResponseRole) UnmarshalJSON(data []byte) (err error)

type OrgUserListResponseRolesOrg 

type OrgUserListResponseRolesOrg struct {
	// Unique Id of this team.
	ID int64 `json:"id"`
	// Org Owner Alternate Contact
	AlternateContact OrgUserListResponseRolesOrgAlternateContact `json:"alternateContact"`
	// Billing account ID.
	BillingAccountID string `json:"billingAccountId"`
	// Identifies if the org can be reused.
	CanAddOn bool `json:"canAddOn"`
	// ISO country code of the organization.
	Country string `json:"country"`
	// Optional description of the organization.
	Description string `json:"description"`
	// Name of the organization that will be shown to users.
	DisplayName string `json:"displayName"`
	// Identity Provider ID.
	IdpID string `json:"idpId"`
	// Industry of the organization.
	Industry string `json:"industry"`
	// Infinity manager setting definition
	InfinityManagerSettings OrgUserListResponseRolesOrgInfinityManagerSettings `json:"infinityManagerSettings"`
	// Dataset Service enable flag for an organization
	IsDatasetServiceEnabled bool `json:"isDatasetServiceEnabled"`
	// Is NVIDIA internal org or not
	IsInternal bool `json:"isInternal"`
	// Indicates when the org is a proto org
	IsProto bool `json:"isProto"`
	// Quick Start enable flag for an organization
	IsQuickStartEnabled bool `json:"isQuickStartEnabled"`
	// If a server side encryption is enabled for private registry (models, resources)
	IsRegistrySseEnabled bool `json:"isRegistrySSEEnabled"`
	// Secrets Manager Service enable flag for an organization
	IsSecretsManagerServiceEnabled bool `json:"isSecretsManagerServiceEnabled"`
	// Secure Credential Sharing Service enable flag for an organization
	IsSecureCredentialSharingServiceEnabled bool `json:"isSecureCredentialSharingServiceEnabled"`
	// If a separate influx db used for an organization in BCP for job telemetry
	IsSeparateInfluxDBUsed bool `json:"isSeparateInfluxDbUsed"`
	// Organization name.
	Name string `json:"name"`
	// NVIDIA Cloud Account Number.
	Nan string `json:"nan"`
	// Org owner.
	OrgOwner OrgUserListResponseRolesOrgOrgOwner `json:"orgOwner"`
	// Org owners
	OrgOwners []OrgUserListResponseRolesOrgOrgOwner `json:"orgOwners"`
	// Product end customer salesforce.com Id (external customer Id). pecSfdcId is for
	// EMS (entitlement management service) to track external paid customer.
	PecSfdcID            string                                           `json:"pecSfdcId"`
	ProductEnablements   []OrgUserListResponseRolesOrgProductEnablement   `json:"productEnablements"`
	ProductSubscriptions []OrgUserListResponseRolesOrgProductSubscription `json:"productSubscriptions"`
	// Repo scan setting definition
	RepoScanSettings OrgUserListResponseRolesOrgRepoScanSettings `json:"repoScanSettings"`
	Type             OrgUserListResponseRolesOrgType             `json:"type"`
	// Users information.
	UsersInfo OrgUserListResponseRolesOrgUsersInfo `json:"usersInfo"`
	JSON      orgUserListResponseRolesOrgJSON      `json:"-"`
}

Information about the Organization

func (*OrgUserListResponseRolesOrg) UnmarshalJSON 

func (r *OrgUserListResponseRolesOrg) UnmarshalJSON(data []byte) (err error)

type OrgUserListResponseRolesOrgAlternateContact 

type OrgUserListResponseRolesOrgAlternateContact struct {
	// Alternate contact's email.
	Email string `json:"email"`
	// Full name of the alternate contact.
	FullName string                                          `json:"fullName"`
	JSON     orgUserListResponseRolesOrgAlternateContactJSON `json:"-"`
}

Org Owner Alternate Contact

func (*OrgUserListResponseRolesOrgAlternateContact) UnmarshalJSON 

func (r *OrgUserListResponseRolesOrgAlternateContact) UnmarshalJSON(data []byte) (err error)

type OrgUserListResponseRolesOrgInfinityManagerSettings 

type OrgUserListResponseRolesOrgInfinityManagerSettings struct {
	// Enable the infinity manager or not. Used both in org and team level object
	InfinityManagerEnabled bool `json:"infinityManagerEnabled"`
	// Allow override settings at team level. Only used in org level object
	InfinityManagerEnableTeamOverride bool                                                   `json:"infinityManagerEnableTeamOverride"`
	JSON                              orgUserListResponseRolesOrgInfinityManagerSettingsJSON `json:"-"`
}

Infinity manager setting definition

func (*OrgUserListResponseRolesOrgInfinityManagerSettings) UnmarshalJSON 

func (r *OrgUserListResponseRolesOrgInfinityManagerSettings) UnmarshalJSON(data []byte) (err error)

type OrgUserListResponseRolesOrgOrgOwner 

type OrgUserListResponseRolesOrgOrgOwner struct {
	// Email address of the org owner.
	Email string `json:"email,required"`
	// Org owner name.
	FullName string `json:"fullName,required"`
	// Last time the org owner logged in.
	LastLoginDate string                                  `json:"lastLoginDate"`
	JSON          orgUserListResponseRolesOrgOrgOwnerJSON `json:"-"`
}

Org owner.

func (*OrgUserListResponseRolesOrgOrgOwner) UnmarshalJSON 

func (r *OrgUserListResponseRolesOrgOrgOwner) UnmarshalJSON(data []byte) (err error)

type OrgUserListResponseRolesOrgProductEnablement 

type OrgUserListResponseRolesOrgProductEnablement struct {
	// Product Name (NVAIE, BASE_COMMAND, REGISTRY, etc)
	ProductName string `json:"productName,required"`
	// Product Enablement Types
	Type OrgUserListResponseRolesOrgProductEnablementsType `json:"type,required"`
	// Date on which the subscription expires. The subscription is invalid after this
	// date. (yyyy-MM-dd)
	ExpirationDate string                                                  `json:"expirationDate"`
	PoDetails      []OrgUserListResponseRolesOrgProductEnablementsPoDetail `json:"poDetails"`
	JSON           orgUserListResponseRolesOrgProductEnablementJSON        `json:"-"`
}

Product Enablement

func (*OrgUserListResponseRolesOrgProductEnablement) UnmarshalJSON 

func (r *OrgUserListResponseRolesOrgProductEnablement) UnmarshalJSON(data []byte) (err error)

type OrgUserListResponseRolesOrgProductEnablementsPoDetail 

type OrgUserListResponseRolesOrgProductEnablementsPoDetail struct {
	// Entitlement identifier.
	EntitlementID string `json:"entitlementId"`
	// PAK (Product Activation Key) identifier.
	PkID string                                                    `json:"pkId"`
	JSON orgUserListResponseRolesOrgProductEnablementsPoDetailJSON `json:"-"`
}

Purchase Order.

func (*OrgUserListResponseRolesOrgProductEnablementsPoDetail) UnmarshalJSON 

func (r *OrgUserListResponseRolesOrgProductEnablementsPoDetail) UnmarshalJSON(data []byte) (err error)

type OrgUserListResponseRolesOrgProductEnablementsType 

type OrgUserListResponseRolesOrgProductEnablementsType string

Product Enablement Types 

const (
	OrgUserListResponseRolesOrgProductEnablementsTypeNgcAdminEval       OrgUserListResponseRolesOrgProductEnablementsType = "NGC_ADMIN_EVAL"
	OrgUserListResponseRolesOrgProductEnablementsTypeNgcAdminNfr        OrgUserListResponseRolesOrgProductEnablementsType = "NGC_ADMIN_NFR"
	OrgUserListResponseRolesOrgProductEnablementsTypeNgcAdminCommercial OrgUserListResponseRolesOrgProductEnablementsType = "NGC_ADMIN_COMMERCIAL"
	OrgUserListResponseRolesOrgProductEnablementsTypeEmsEval            OrgUserListResponseRolesOrgProductEnablementsType = "EMS_EVAL"
	OrgUserListResponseRolesOrgProductEnablementsTypeEmsNfr             OrgUserListResponseRolesOrgProductEnablementsType = "EMS_NFR"
	OrgUserListResponseRolesOrgProductEnablementsTypeEmsCommercial      OrgUserListResponseRolesOrgProductEnablementsType = "EMS_COMMERCIAL"
	OrgUserListResponseRolesOrgProductEnablementsTypeNgcAdminDeveloper  OrgUserListResponseRolesOrgProductEnablementsType = "NGC_ADMIN_DEVELOPER"
)

func (OrgUserListResponseRolesOrgProductEnablementsType) IsKnown 

func (r OrgUserListResponseRolesOrgProductEnablementsType) IsKnown() bool

type OrgUserListResponseRolesOrgProductSubscription 

type OrgUserListResponseRolesOrgProductSubscription struct {
	// Product Name (NVAIE, BASE_COMMAND, FleetCommand, REGISTRY, etc).
	ProductName string `json:"productName,required"`
	// Unique entitlement identifier
	ID string `json:"id"`
	// EMS Subscription type. (options: EMS_EVAL, EMS_NFR and EMS_COMMERCIAL)
	EmsEntitlementType OrgUserListResponseRolesOrgProductSubscriptionsEmsEntitlementType `json:"emsEntitlementType"`
	// Date on which the subscription expires. The subscription is invalid after this
	// date. (yyyy-MM-dd)
	ExpirationDate string `json:"expirationDate"`
	// Date on which the subscription becomes active. (yyyy-MM-dd)
	StartDate string `json:"startDate"`
	// Subscription type. (options: NGC_ADMIN_EVAL, NGC_ADMIN_NFR,
	// NGC_ADMIN_COMMERCIAL)
	Type OrgUserListResponseRolesOrgProductSubscriptionsType `json:"type"`
	JSON orgUserListResponseRolesOrgProductSubscriptionJSON  `json:"-"`
}

Product Subscription

func (*OrgUserListResponseRolesOrgProductSubscription) UnmarshalJSON 

func (r *OrgUserListResponseRolesOrgProductSubscription) UnmarshalJSON(data []byte) (err error)

type OrgUserListResponseRolesOrgProductSubscriptionsEmsEntitlementType 

type OrgUserListResponseRolesOrgProductSubscriptionsEmsEntitlementType string

EMS Subscription type. (options: EMS_EVAL, EMS_NFR and EMS_COMMERCIAL) 

const (
	OrgUserListResponseRolesOrgProductSubscriptionsEmsEntitlementTypeEmsEval       OrgUserListResponseRolesOrgProductSubscriptionsEmsEntitlementType = "EMS_EVAL"
	OrgUserListResponseRolesOrgProductSubscriptionsEmsEntitlementTypeEmsNfr        OrgUserListResponseRolesOrgProductSubscriptionsEmsEntitlementType = "EMS_NFR"
	OrgUserListResponseRolesOrgProductSubscriptionsEmsEntitlementTypeEmsCommerical OrgUserListResponseRolesOrgProductSubscriptionsEmsEntitlementType = "EMS_COMMERICAL"
	OrgUserListResponseRolesOrgProductSubscriptionsEmsEntitlementTypeEmsCommercial OrgUserListResponseRolesOrgProductSubscriptionsEmsEntitlementType = "EMS_COMMERCIAL"
)

func (OrgUserListResponseRolesOrgProductSubscriptionsEmsEntitlementType) IsKnown 

func (r OrgUserListResponseRolesOrgProductSubscriptionsEmsEntitlementType) IsKnown() bool

type OrgUserListResponseRolesOrgProductSubscriptionsType 

type OrgUserListResponseRolesOrgProductSubscriptionsType string

Subscription type. (options: NGC_ADMIN_EVAL, NGC_ADMIN_NFR, NGC_ADMIN_COMMERCIAL) 

const (
	OrgUserListResponseRolesOrgProductSubscriptionsTypeNgcAdminEval       OrgUserListResponseRolesOrgProductSubscriptionsType = "NGC_ADMIN_EVAL"
	OrgUserListResponseRolesOrgProductSubscriptionsTypeNgcAdminNfr        OrgUserListResponseRolesOrgProductSubscriptionsType = "NGC_ADMIN_NFR"
	OrgUserListResponseRolesOrgProductSubscriptionsTypeNgcAdminCommercial OrgUserListResponseRolesOrgProductSubscriptionsType = "NGC_ADMIN_COMMERCIAL"
)

func (OrgUserListResponseRolesOrgProductSubscriptionsType) IsKnown 

func (r OrgUserListResponseRolesOrgProductSubscriptionsType) IsKnown() bool

type OrgUserListResponseRolesOrgRepoScanSettings 

type OrgUserListResponseRolesOrgRepoScanSettings struct {
	// Allow org admin to override the org level repo scan settings
	RepoScanAllowOverride bool `json:"repoScanAllowOverride"`
	// Allow repository scanning by default
	RepoScanByDefault bool `json:"repoScanByDefault"`
	// Enable the repository scan or not. Only used in org level object
	RepoScanEnabled bool `json:"repoScanEnabled"`
	// Sends notification to end user after scanning is done
	RepoScanEnableNotifications bool `json:"repoScanEnableNotifications"`
	// Allow override settings at team level. Only used in org level object
	RepoScanEnableTeamOverride bool `json:"repoScanEnableTeamOverride"`
	// Allow showing scan results to CLI or UI
	RepoScanShowResults bool                                            `json:"repoScanShowResults"`
	JSON                orgUserListResponseRolesOrgRepoScanSettingsJSON `json:"-"`
}

Repo scan setting definition

func (*OrgUserListResponseRolesOrgRepoScanSettings) UnmarshalJSON 

func (r *OrgUserListResponseRolesOrgRepoScanSettings) UnmarshalJSON(data []byte) (err error)

type OrgUserListResponseRolesOrgType 

type OrgUserListResponseRolesOrgType string
const (
	OrgUserListResponseRolesOrgTypeUnknown    OrgUserListResponseRolesOrgType = "UNKNOWN"
	OrgUserListResponseRolesOrgTypeCloud      OrgUserListResponseRolesOrgType = "CLOUD"
	OrgUserListResponseRolesOrgTypeEnterprise OrgUserListResponseRolesOrgType = "ENTERPRISE"
	OrgUserListResponseRolesOrgTypeIndividual OrgUserListResponseRolesOrgType = "INDIVIDUAL"
)

func (OrgUserListResponseRolesOrgType) IsKnown 

func (r OrgUserListResponseRolesOrgType) IsKnown() bool

type OrgUserListResponseRolesOrgUsersInfo 

type OrgUserListResponseRolesOrgUsersInfo struct {
	// Total number of users.
	TotalUsers int64                                    `json:"totalUsers"`
	JSON       orgUserListResponseRolesOrgUsersInfoJSON `json:"-"`
}

Users information.

func (*OrgUserListResponseRolesOrgUsersInfo) UnmarshalJSON 

func (r *OrgUserListResponseRolesOrgUsersInfo) UnmarshalJSON(data []byte) (err error)

type OrgUserListResponseRolesTargetSystemUserIdentifier 

type OrgUserListResponseRolesTargetSystemUserIdentifier struct {
	// gid of the user on this team
	Gid int64 `json:"gid"`
	// Org context for the job
	OrgName string `json:"orgName"`
	// Starfleet ID of the user creating the job.
	StarfleetID string `json:"starfleetId"`
	// Team context for the job
	TeamName string `json:"teamName"`
	// uid of the user on this team
	Uid int64 `json:"uid"`
	// Unique ID of the user who submitted the job
	UserID int64                                                  `json:"userId"`
	JSON   orgUserListResponseRolesTargetSystemUserIdentifierJSON `json:"-"`
}

Information about the user who is attempting to run the job

func (*OrgUserListResponseRolesTargetSystemUserIdentifier) UnmarshalJSON 

func (r *OrgUserListResponseRolesTargetSystemUserIdentifier) UnmarshalJSON(data []byte) (err error)

type OrgUserListResponseRolesTeam 

type OrgUserListResponseRolesTeam struct {
	// unique Id of this team.
	ID int64 `json:"id"`
	// description of the team
	Description string `json:"description"`
	// Infinity manager setting definition
	InfinityManagerSettings OrgUserListResponseRolesTeamInfinityManagerSettings `json:"infinityManagerSettings"`
	// indicates if the team is deleted or not
	IsDeleted bool `json:"isDeleted"`
	// team name
	Name string `json:"name"`
	// Repo scan setting definition
	RepoScanSettings OrgUserListResponseRolesTeamRepoScanSettings `json:"repoScanSettings"`
	JSON             orgUserListResponseRolesTeamJSON             `json:"-"`
}

Information about the team

func (*OrgUserListResponseRolesTeam) UnmarshalJSON 

func (r *OrgUserListResponseRolesTeam) UnmarshalJSON(data []byte) (err error)

type OrgUserListResponseRolesTeamInfinityManagerSettings 

type OrgUserListResponseRolesTeamInfinityManagerSettings struct {
	// Enable the infinity manager or not. Used both in org and team level object
	InfinityManagerEnabled bool `json:"infinityManagerEnabled"`
	// Allow override settings at team level. Only used in org level object
	InfinityManagerEnableTeamOverride bool                                                    `json:"infinityManagerEnableTeamOverride"`
	JSON                              orgUserListResponseRolesTeamInfinityManagerSettingsJSON `json:"-"`
}

Infinity manager setting definition

func (*OrgUserListResponseRolesTeamInfinityManagerSettings) UnmarshalJSON 

func (r *OrgUserListResponseRolesTeamInfinityManagerSettings) UnmarshalJSON(data []byte) (err error)

type OrgUserListResponseRolesTeamRepoScanSettings 

type OrgUserListResponseRolesTeamRepoScanSettings struct {
	// Allow org admin to override the org level repo scan settings
	RepoScanAllowOverride bool `json:"repoScanAllowOverride"`
	// Allow repository scanning by default
	RepoScanByDefault bool `json:"repoScanByDefault"`
	// Enable the repository scan or not. Only used in org level object
	RepoScanEnabled bool `json:"repoScanEnabled"`
	// Sends notification to end user after scanning is done
	RepoScanEnableNotifications bool `json:"repoScanEnableNotifications"`
	// Allow override settings at team level. Only used in org level object
	RepoScanEnableTeamOverride bool `json:"repoScanEnableTeamOverride"`
	// Allow showing scan results to CLI or UI
	RepoScanShowResults bool                                             `json:"repoScanShowResults"`
	JSON                orgUserListResponseRolesTeamRepoScanSettingsJSON `json:"-"`
}

Repo scan setting definition

func (*OrgUserListResponseRolesTeamRepoScanSettings) UnmarshalJSON 

func (r *OrgUserListResponseRolesTeamRepoScanSettings) UnmarshalJSON(data []byte) (err error)

type OrgUserListResponseStorageQuota 

type OrgUserListResponseStorageQuota struct {
	// id of the ace
	AceID int64 `json:"aceId"`
	// name of the ace
	AceName string `json:"aceName"`
	// Available space in bytes
	Available int64 `json:"available"`
	// Number of datasets that are a part of user's used storage
	DatasetCount int64 `json:"datasetCount"`
	// Space used by datasets in bytes
	DatasetsUsage int64 `json:"datasetsUsage"`
	// The org name that this user quota tied to. This is needed for analytics
	OrgName string `json:"orgName"`
	// Assigned quota in bytes
	Quota int64 `json:"quota"`
	// Number of resultsets that are a part of user's used storage
	ResultsetCount int64 `json:"resultsetCount"`
	// Space used by resultsets in bytes
	ResultsetsUsage int64 `json:"resultsetsUsage"`
	// Description of this storage cluster
	StorageClusterDescription string `json:"storageClusterDescription"`
	// Name of storage cluster
	StorageClusterName string `json:"storageClusterName"`
	// Identifier to this storage cluster
	StorageClusterUuid string `json:"storageClusterUuid"`
	// Number of workspaces that are a part of user's used storage
	WorkspacesCount int64 `json:"workspacesCount"`
	// Space used by workspaces in bytes
	WorkspacesUsage int64                               `json:"workspacesUsage"`
	JSON            orgUserListResponseStorageQuotaJSON `json:"-"`
}

represents user storage quota for a given ace and available unused storage

func (*OrgUserListResponseStorageQuota) UnmarshalJSON 

func (r *OrgUserListResponseStorageQuota) UnmarshalJSON(data []byte) (err error)

type OrgUserListResponseUserMetadata 

type OrgUserListResponseUserMetadata struct {
	// Name of the company
	Company string `json:"company"`
	// Company URL
	CompanyURL string `json:"companyUrl"`
	// Country of the user
	Country string `json:"country"`
	// User's first name
	FirstName string `json:"firstName"`
	// Industry segment
	Industry string `json:"industry"`
	// List of development areas that user has interest
	Interest []string `json:"interest"`
	// User's last name
	LastName string `json:"lastName"`
	// Role of the user in the company
	Role string                              `json:"role"`
	JSON orgUserListResponseUserMetadataJSON `json:"-"`
}

Metadata information about the user.

func (*OrgUserListResponseUserMetadata) UnmarshalJSON 

func (r *OrgUserListResponseUserMetadata) UnmarshalJSON(data []byte) (err error)

type OrgUserNcaInvitationNewParams 

type OrgUserNcaInvitationNewParams struct {
	// Is the user email
	Email param.Field[string] `json:"email"`
	// Is the numbers of days the invitation will expire
	InvitationExpirationIn param.Field[int64] `json:"invitationExpirationIn"`
	// Nca allow users to be invited as Admin and as Member
	InviteAs param.Field[OrgUserNcaInvitationNewParamsInviteAs] `json:"inviteAs"`
	// Is a message to the new user
	Message param.Field[string] `json:"message"`
}

func (OrgUserNcaInvitationNewParams) MarshalJSON 

func (r OrgUserNcaInvitationNewParams) MarshalJSON() (data []byte, err error)

type OrgUserNcaInvitationNewParamsInviteAs 

type OrgUserNcaInvitationNewParamsInviteAs string

Nca allow users to be invited as Admin and as Member 

const (
	OrgUserNcaInvitationNewParamsInviteAsAdmin  OrgUserNcaInvitationNewParamsInviteAs = "ADMIN"
	OrgUserNcaInvitationNewParamsInviteAsMember OrgUserNcaInvitationNewParamsInviteAs = "MEMBER"
)

func (OrgUserNcaInvitationNewParamsInviteAs) IsKnown 

func (r OrgUserNcaInvitationNewParamsInviteAs) IsKnown() bool

type OrgUserNcaInvitationService 

type OrgUserNcaInvitationService struct {
	Options []option.RequestOption
}

OrgUserNcaInvitationService contains methods and other services that help with interacting with the ngc API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewOrgUserNcaInvitationService method instead.

func NewOrgUserNcaInvitationService 

func NewOrgUserNcaInvitationService(opts ...option.RequestOption) (r *OrgUserNcaInvitationService)

NewOrgUserNcaInvitationService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*OrgUserNcaInvitationService) New 

func (r *OrgUserNcaInvitationService) New(ctx context.Context, orgName string, body OrgUserNcaInvitationNewParams, opts ...option.RequestOption) (res *shared.User, err error)

Invites and creates a User in org

type OrgUserNewParams 

type OrgUserNewParams struct {
	// Email address of the user. This should be unique.
	Email param.Field[string] `json:"email,required"`
	// If the IDP ID is provided then it is used instead of the one configured for the
	// organization
	IdpID     param.Field[string] `query:"idp-id"`
	SendEmail param.Field[bool]   `query:"send-email"`
	// indicates if user has opt in to nvidia emails
	EmailOptIn param.Field[bool] `json:"emailOptIn"`
	// indicates if user has accepted EULA
	EulaAccepted param.Field[bool] `json:"eulaAccepted"`
	// user name
	Name param.Field[string] `json:"name"`
	// DEPRECATED - use roleTypes which allows multiple roles
	RoleType param.Field[string] `json:"roleType"`
	// feature roles to give to the user
	RoleTypes param.Field[[]string] `json:"roleTypes"`
	// user job role
	SalesforceContactJobRole param.Field[string] `json:"salesforceContactJobRole"`
	// Metadata information about the user.
	UserMetadata param.Field[OrgUserNewParamsUserMetadata] `json:"userMetadata"`
	Ncid         param.Field[string]                       `cookie:"ncid"`
	VisitorID    param.Field[string]                       `cookie:"VisitorID"`
}

func (OrgUserNewParams) MarshalJSON 

func (r OrgUserNewParams) MarshalJSON() (data []byte, err error)

func (OrgUserNewParams) URLQuery 

func (r OrgUserNewParams) URLQuery() (v url.Values)

URLQuery serializes OrgUserNewParams's query parameters as `url.Values`.

type OrgUserNewParamsUserMetadata 

type OrgUserNewParamsUserMetadata struct {
	// Name of the company
	Company param.Field[string] `json:"company"`
	// Company URL
	CompanyURL param.Field[string] `json:"companyUrl"`
	// Country of the user
	Country param.Field[string] `json:"country"`
	// User's first name
	FirstName param.Field[string] `json:"firstName"`
	// Industry segment
	Industry param.Field[string] `json:"industry"`
	// List of development areas that user has interest
	Interest param.Field[[]string] `json:"interest"`
	// User's last name
	LastName param.Field[string] `json:"lastName"`
	// Role of the user in the company
	Role param.Field[string] `json:"role"`
}

Metadata information about the user.

func (OrgUserNewParamsUserMetadata) MarshalJSON 

func (r OrgUserNewParamsUserMetadata) MarshalJSON() (data []byte, err error)

type OrgUserRemoveRoleParams 

type OrgUserRemoveRoleParams struct {
	Roles param.Field[[]string] `query:"roles"`
}

func (OrgUserRemoveRoleParams) URLQuery 

func (r OrgUserRemoveRoleParams) URLQuery() (v url.Values)

URLQuery serializes OrgUserRemoveRoleParams's query parameters as `url.Values`.

type OrgUserService 

type OrgUserService struct {
	Options        []option.RequestOption
	NcaInvitations *OrgUserNcaInvitationService
}

OrgUserService contains methods and other services that help with interacting with the ngc API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewOrgUserService method instead.

func NewOrgUserService 

func NewOrgUserService(opts ...option.RequestOption) (r *OrgUserService)

NewOrgUserService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*OrgUserService) AddRole 

func (r *OrgUserService) AddRole(ctx context.Context, orgName string, userEmailOrID string, params OrgUserAddRoleParams, opts ...option.RequestOption) (res *shared.User, err error)

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

func (*OrgUserService) Delete 

func (r *OrgUserService) Delete(ctx context.Context, orgName string, id string, body OrgUserDeleteParams, opts ...option.RequestOption) (res *OrgUserDeleteResponse, err error)

Remove User from org.

func (*OrgUserService) List 

func (r *OrgUserService) List(ctx context.Context, orgName string, query OrgUserListParams, opts ...option.RequestOption) (res *pagination.PageNumberUsers[shared.OrgUserListResponse], err error)

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

func (*OrgUserService) ListAutoPaging 

func (r *OrgUserService) ListAutoPaging(ctx context.Context, orgName string, query OrgUserListParams, opts ...option.RequestOption) *pagination.PageNumberUsersAutoPager[shared.OrgUserListResponse]

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

func (*OrgUserService) New 

func (r *OrgUserService) New(ctx context.Context, orgName string, params OrgUserNewParams, opts ...option.RequestOption) (res *shared.User, err error)

Creates a User

func (*OrgUserService) RemoveRole 

func (r *OrgUserService) RemoveRole(ctx context.Context, orgName string, userEmailOrID string, body OrgUserRemoveRoleParams, opts ...option.RequestOption) (res *shared.User, err error)

Remove role in org if user exists, otherwise remove invitation

func (*OrgUserService) UpdateRole 

func (r *OrgUserService) UpdateRole(ctx context.Context, orgName string, id string, body OrgUserUpdateRoleParams, opts ...option.RequestOption) (res *shared.User, err error)

Update User Role in org

type OrgUserUpdateRoleParams 

type OrgUserUpdateRoleParams struct {
	Roles param.Field[[]string] `query:"roles"`
}

func (OrgUserUpdateRoleParams) URLQuery 

func (r OrgUserUpdateRoleParams) URLQuery() (v url.Values)

URLQuery serializes OrgUserUpdateRoleParams's query parameters as `url.Values`.

type OrganizationAuditLogDeleteParams 

type OrganizationAuditLogDeleteParams struct {
	LogIDs param.Field[[]string] `query:"logIds,required"`
}

func (OrganizationAuditLogDeleteParams) URLQuery 

func (r OrganizationAuditLogDeleteParams) URLQuery() (v url.Values)

URLQuery serializes OrganizationAuditLogDeleteParams's query parameters as `url.Values`.

type OrganizationAuditLogDeleteResponse 

type OrganizationAuditLogDeleteResponse struct {
	RequestStatus OrganizationAuditLogDeleteResponseRequestStatus `json:"requestStatus"`
	JSON          organizationAuditLogDeleteResponseJSON          `json:"-"`
}

func (*OrganizationAuditLogDeleteResponse) UnmarshalJSON 

func (r *OrganizationAuditLogDeleteResponse) UnmarshalJSON(data []byte) (err error)

type OrganizationAuditLogDeleteResponseRequestStatus 

type OrganizationAuditLogDeleteResponseRequestStatus struct {
	RequestID string `json:"requestId"`
	ServerID  string `json:"serverId"`
	// Describes response status reported by the server.
	StatusCode        OrganizationAuditLogDeleteResponseRequestStatusStatusCode `json:"statusCode"`
	StatusDescription string                                                    `json:"statusDescription"`
	JSON              organizationAuditLogDeleteResponseRequestStatusJSON       `json:"-"`
}

func (*OrganizationAuditLogDeleteResponseRequestStatus) UnmarshalJSON 

func (r *OrganizationAuditLogDeleteResponseRequestStatus) UnmarshalJSON(data []byte) (err error)

type OrganizationAuditLogDeleteResponseRequestStatusStatusCode 

type OrganizationAuditLogDeleteResponseRequestStatusStatusCode string

Describes response status reported by the server. 

const (
	OrganizationAuditLogDeleteResponseRequestStatusStatusCodeUnknown                    OrganizationAuditLogDeleteResponseRequestStatusStatusCode = "UNKNOWN"
	OrganizationAuditLogDeleteResponseRequestStatusStatusCodeSuccess                    OrganizationAuditLogDeleteResponseRequestStatusStatusCode = "SUCCESS"
	OrganizationAuditLogDeleteResponseRequestStatusStatusCodeUnauthorized               OrganizationAuditLogDeleteResponseRequestStatusStatusCode = "UNAUTHORIZED"
	OrganizationAuditLogDeleteResponseRequestStatusStatusCodePaymentRequired            OrganizationAuditLogDeleteResponseRequestStatusStatusCode = "PAYMENT_REQUIRED"
	OrganizationAuditLogDeleteResponseRequestStatusStatusCodeForbidden                  OrganizationAuditLogDeleteResponseRequestStatusStatusCode = "FORBIDDEN"
	OrganizationAuditLogDeleteResponseRequestStatusStatusCodeTimeout                    OrganizationAuditLogDeleteResponseRequestStatusStatusCode = "TIMEOUT"
	OrganizationAuditLogDeleteResponseRequestStatusStatusCodeExists                     OrganizationAuditLogDeleteResponseRequestStatusStatusCode = "EXISTS"
	OrganizationAuditLogDeleteResponseRequestStatusStatusCodeNotFound                   OrganizationAuditLogDeleteResponseRequestStatusStatusCode = "NOT_FOUND"
	OrganizationAuditLogDeleteResponseRequestStatusStatusCodeInternalError              OrganizationAuditLogDeleteResponseRequestStatusStatusCode = "INTERNAL_ERROR"
	OrganizationAuditLogDeleteResponseRequestStatusStatusCodeInvalidRequest             OrganizationAuditLogDeleteResponseRequestStatusStatusCode = "INVALID_REQUEST"
	OrganizationAuditLogDeleteResponseRequestStatusStatusCodeInvalidRequestVersion      OrganizationAuditLogDeleteResponseRequestStatusStatusCode = "INVALID_REQUEST_VERSION"
	OrganizationAuditLogDeleteResponseRequestStatusStatusCodeInvalidRequestData         OrganizationAuditLogDeleteResponseRequestStatusStatusCode = "INVALID_REQUEST_DATA"
	OrganizationAuditLogDeleteResponseRequestStatusStatusCodeMethodNotAllowed           OrganizationAuditLogDeleteResponseRequestStatusStatusCode = "METHOD_NOT_ALLOWED"
	OrganizationAuditLogDeleteResponseRequestStatusStatusCodeConflict                   OrganizationAuditLogDeleteResponseRequestStatusStatusCode = "CONFLICT"
	OrganizationAuditLogDeleteResponseRequestStatusStatusCodeUnprocessableEntity        OrganizationAuditLogDeleteResponseRequestStatusStatusCode = "UNPROCESSABLE_ENTITY"
	OrganizationAuditLogDeleteResponseRequestStatusStatusCodeTooManyRequests            OrganizationAuditLogDeleteResponseRequestStatusStatusCode = "TOO_MANY_REQUESTS"
	OrganizationAuditLogDeleteResponseRequestStatusStatusCodeInsufficientStorage        OrganizationAuditLogDeleteResponseRequestStatusStatusCode = "INSUFFICIENT_STORAGE"
	OrganizationAuditLogDeleteResponseRequestStatusStatusCodeServiceUnavailable         OrganizationAuditLogDeleteResponseRequestStatusStatusCode = "SERVICE_UNAVAILABLE"
	OrganizationAuditLogDeleteResponseRequestStatusStatusCodePayloadTooLarge            OrganizationAuditLogDeleteResponseRequestStatusStatusCode = "PAYLOAD_TOO_LARGE"
	OrganizationAuditLogDeleteResponseRequestStatusStatusCodeNotAcceptable              OrganizationAuditLogDeleteResponseRequestStatusStatusCode = "NOT_ACCEPTABLE"
	OrganizationAuditLogDeleteResponseRequestStatusStatusCodeUnavailableForLegalReasons OrganizationAuditLogDeleteResponseRequestStatusStatusCode = "UNAVAILABLE_FOR_LEGAL_REASONS"
	OrganizationAuditLogDeleteResponseRequestStatusStatusCodeBadGateway                 OrganizationAuditLogDeleteResponseRequestStatusStatusCode = "BAD_GATEWAY"
)

func (OrganizationAuditLogDeleteResponseRequestStatusStatusCode) IsKnown 

func (r OrganizationAuditLogDeleteResponseRequestStatusStatusCode) IsKnown() bool

type OrganizationAuditLogRequestParams 

type OrganizationAuditLogRequestParams struct {
	// Audit logs from date in ISO-8601 format
	AuditLogsFrom param.Field[string] `json:"auditLogsFrom,required"`
	// Audit logs to date in ISO-8601 format
	AuditLogsTo param.Field[string] `json:"auditLogsTo,required"`
}

func (OrganizationAuditLogRequestParams) MarshalJSON 

func (r OrganizationAuditLogRequestParams) MarshalJSON() (data []byte, err error)

type OrganizationAuditLogRequestResponse 

type OrganizationAuditLogRequestResponse struct {
	RequestStatus OrganizationAuditLogRequestResponseRequestStatus `json:"requestStatus"`
	JSON          organizationAuditLogRequestResponseJSON          `json:"-"`
}

func (*OrganizationAuditLogRequestResponse) UnmarshalJSON 

func (r *OrganizationAuditLogRequestResponse) UnmarshalJSON(data []byte) (err error)

type OrganizationAuditLogRequestResponseRequestStatus 

type OrganizationAuditLogRequestResponseRequestStatus struct {
	RequestID string `json:"requestId"`
	ServerID  string `json:"serverId"`
	// Describes response status reported by the server.
	StatusCode        OrganizationAuditLogRequestResponseRequestStatusStatusCode `json:"statusCode"`
	StatusDescription string                                                     `json:"statusDescription"`
	JSON              organizationAuditLogRequestResponseRequestStatusJSON       `json:"-"`
}

func (*OrganizationAuditLogRequestResponseRequestStatus) UnmarshalJSON 

func (r *OrganizationAuditLogRequestResponseRequestStatus) UnmarshalJSON(data []byte) (err error)

type OrganizationAuditLogRequestResponseRequestStatusStatusCode 

type OrganizationAuditLogRequestResponseRequestStatusStatusCode string

Describes response status reported by the server. 

const (
	OrganizationAuditLogRequestResponseRequestStatusStatusCodeUnknown                    OrganizationAuditLogRequestResponseRequestStatusStatusCode = "UNKNOWN"
	OrganizationAuditLogRequestResponseRequestStatusStatusCodeSuccess                    OrganizationAuditLogRequestResponseRequestStatusStatusCode = "SUCCESS"
	OrganizationAuditLogRequestResponseRequestStatusStatusCodeUnauthorized               OrganizationAuditLogRequestResponseRequestStatusStatusCode = "UNAUTHORIZED"
	OrganizationAuditLogRequestResponseRequestStatusStatusCodePaymentRequired            OrganizationAuditLogRequestResponseRequestStatusStatusCode = "PAYMENT_REQUIRED"
	OrganizationAuditLogRequestResponseRequestStatusStatusCodeForbidden                  OrganizationAuditLogRequestResponseRequestStatusStatusCode = "FORBIDDEN"
	OrganizationAuditLogRequestResponseRequestStatusStatusCodeTimeout                    OrganizationAuditLogRequestResponseRequestStatusStatusCode = "TIMEOUT"
	OrganizationAuditLogRequestResponseRequestStatusStatusCodeExists                     OrganizationAuditLogRequestResponseRequestStatusStatusCode = "EXISTS"
	OrganizationAuditLogRequestResponseRequestStatusStatusCodeNotFound                   OrganizationAuditLogRequestResponseRequestStatusStatusCode = "NOT_FOUND"
	OrganizationAuditLogRequestResponseRequestStatusStatusCodeInternalError              OrganizationAuditLogRequestResponseRequestStatusStatusCode = "INTERNAL_ERROR"
	OrganizationAuditLogRequestResponseRequestStatusStatusCodeInvalidRequest             OrganizationAuditLogRequestResponseRequestStatusStatusCode = "INVALID_REQUEST"
	OrganizationAuditLogRequestResponseRequestStatusStatusCodeInvalidRequestVersion      OrganizationAuditLogRequestResponseRequestStatusStatusCode = "INVALID_REQUEST_VERSION"
	OrganizationAuditLogRequestResponseRequestStatusStatusCodeInvalidRequestData         OrganizationAuditLogRequestResponseRequestStatusStatusCode = "INVALID_REQUEST_DATA"
	OrganizationAuditLogRequestResponseRequestStatusStatusCodeMethodNotAllowed           OrganizationAuditLogRequestResponseRequestStatusStatusCode = "METHOD_NOT_ALLOWED"
	OrganizationAuditLogRequestResponseRequestStatusStatusCodeConflict                   OrganizationAuditLogRequestResponseRequestStatusStatusCode = "CONFLICT"
	OrganizationAuditLogRequestResponseRequestStatusStatusCodeUnprocessableEntity        OrganizationAuditLogRequestResponseRequestStatusStatusCode = "UNPROCESSABLE_ENTITY"
	OrganizationAuditLogRequestResponseRequestStatusStatusCodeTooManyRequests            OrganizationAuditLogRequestResponseRequestStatusStatusCode = "TOO_MANY_REQUESTS"
	OrganizationAuditLogRequestResponseRequestStatusStatusCodeInsufficientStorage        OrganizationAuditLogRequestResponseRequestStatusStatusCode = "INSUFFICIENT_STORAGE"
	OrganizationAuditLogRequestResponseRequestStatusStatusCodeServiceUnavailable         OrganizationAuditLogRequestResponseRequestStatusStatusCode = "SERVICE_UNAVAILABLE"
	OrganizationAuditLogRequestResponseRequestStatusStatusCodePayloadTooLarge            OrganizationAuditLogRequestResponseRequestStatusStatusCode = "PAYLOAD_TOO_LARGE"
	OrganizationAuditLogRequestResponseRequestStatusStatusCodeNotAcceptable              OrganizationAuditLogRequestResponseRequestStatusStatusCode = "NOT_ACCEPTABLE"
	OrganizationAuditLogRequestResponseRequestStatusStatusCodeUnavailableForLegalReasons OrganizationAuditLogRequestResponseRequestStatusStatusCode = "UNAVAILABLE_FOR_LEGAL_REASONS"
	OrganizationAuditLogRequestResponseRequestStatusStatusCodeBadGateway                 OrganizationAuditLogRequestResponseRequestStatusStatusCode = "BAD_GATEWAY"
)

func (OrganizationAuditLogRequestResponseRequestStatusStatusCode) IsKnown 

func (r OrganizationAuditLogRequestResponseRequestStatusStatusCode) IsKnown() bool

type OrganizationAuditLogService 

type OrganizationAuditLogService struct {
	Options []option.RequestOption
}

OrganizationAuditLogService contains methods and other services that help with interacting with the ngc API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewOrganizationAuditLogService method instead.

func NewOrganizationAuditLogService 

func NewOrganizationAuditLogService(opts ...option.RequestOption) (r *OrganizationAuditLogService)

NewOrganizationAuditLogService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*OrganizationAuditLogService) Delete 

func (r *OrganizationAuditLogService) Delete(ctx context.Context, orgName string, body OrganizationAuditLogDeleteParams, opts ...option.RequestOption) (res *OrganizationAuditLogDeleteResponse, err error)

Delete audit logs

func (*OrganizationAuditLogService) GetAll 

func (r *OrganizationAuditLogService) GetAll(ctx context.Context, orgName string, opts ...option.RequestOption) (res *AuditLogsResponse, err error)

List audit logs

func (*OrganizationAuditLogService) Request 

func (r *OrganizationAuditLogService) Request(ctx context.Context, orgName string, body OrganizationAuditLogRequestParams, opts ...option.RequestOption) (res *OrganizationAuditLogRequestResponse, err error)

Request audit logs

type OrganizationService 

type OrganizationService struct {
	Options   []option.RequestOption
	Teams     *OrganizationTeamService
	AuditLogs *OrganizationAuditLogService
}

OrganizationService contains methods and other services that help with interacting with the ngc API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewOrganizationService method instead.

func NewOrganizationService 

func NewOrganizationService(opts ...option.RequestOption) (r *OrganizationService)

NewOrganizationService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

type OrganizationTeamNewParams 

type OrganizationTeamNewParams struct {
	// team name
	Name param.Field[string] `json:"name,required"`
	// description of the team
	Description param.Field[string] `json:"description"`
}

func (OrganizationTeamNewParams) MarshalJSON 

func (r OrganizationTeamNewParams) MarshalJSON() (data []byte, err error)

type OrganizationTeamService 

type OrganizationTeamService struct {
	Options []option.RequestOption
	Users   *OrganizationTeamUserService
}

OrganizationTeamService contains methods and other services that help with interacting with the ngc API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewOrganizationTeamService method instead.

func NewOrganizationTeamService 

func NewOrganizationTeamService(opts ...option.RequestOption) (r *OrganizationTeamService)

NewOrganizationTeamService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*OrganizationTeamService) New 

func (r *OrganizationTeamService) New(ctx context.Context, orgName string, body OrganizationTeamNewParams, opts ...option.RequestOption) (res *TeamCreateResponse, err error)

Create team in org. (Org Admin Privileges Required)

type OrganizationTeamUserDeleteResponse 

type OrganizationTeamUserDeleteResponse struct {
	RequestStatus OrganizationTeamUserDeleteResponseRequestStatus `json:"requestStatus"`
	JSON          organizationTeamUserDeleteResponseJSON          `json:"-"`
}

func (*OrganizationTeamUserDeleteResponse) UnmarshalJSON 

func (r *OrganizationTeamUserDeleteResponse) UnmarshalJSON(data []byte) (err error)

type OrganizationTeamUserDeleteResponseRequestStatus 

type OrganizationTeamUserDeleteResponseRequestStatus struct {
	RequestID string `json:"requestId"`
	ServerID  string `json:"serverId"`
	// Describes response status reported by the server.
	StatusCode        OrganizationTeamUserDeleteResponseRequestStatusStatusCode `json:"statusCode"`
	StatusDescription string                                                    `json:"statusDescription"`
	JSON              organizationTeamUserDeleteResponseRequestStatusJSON       `json:"-"`
}

func (*OrganizationTeamUserDeleteResponseRequestStatus) UnmarshalJSON 

func (r *OrganizationTeamUserDeleteResponseRequestStatus) UnmarshalJSON(data []byte) (err error)

type OrganizationTeamUserDeleteResponseRequestStatusStatusCode 

type OrganizationTeamUserDeleteResponseRequestStatusStatusCode string

Describes response status reported by the server. 

const (
	OrganizationTeamUserDeleteResponseRequestStatusStatusCodeUnknown                    OrganizationTeamUserDeleteResponseRequestStatusStatusCode = "UNKNOWN"
	OrganizationTeamUserDeleteResponseRequestStatusStatusCodeSuccess                    OrganizationTeamUserDeleteResponseRequestStatusStatusCode = "SUCCESS"
	OrganizationTeamUserDeleteResponseRequestStatusStatusCodeUnauthorized               OrganizationTeamUserDeleteResponseRequestStatusStatusCode = "UNAUTHORIZED"
	OrganizationTeamUserDeleteResponseRequestStatusStatusCodePaymentRequired            OrganizationTeamUserDeleteResponseRequestStatusStatusCode = "PAYMENT_REQUIRED"
	OrganizationTeamUserDeleteResponseRequestStatusStatusCodeForbidden                  OrganizationTeamUserDeleteResponseRequestStatusStatusCode = "FORBIDDEN"
	OrganizationTeamUserDeleteResponseRequestStatusStatusCodeTimeout                    OrganizationTeamUserDeleteResponseRequestStatusStatusCode = "TIMEOUT"
	OrganizationTeamUserDeleteResponseRequestStatusStatusCodeExists                     OrganizationTeamUserDeleteResponseRequestStatusStatusCode = "EXISTS"
	OrganizationTeamUserDeleteResponseRequestStatusStatusCodeNotFound                   OrganizationTeamUserDeleteResponseRequestStatusStatusCode = "NOT_FOUND"
	OrganizationTeamUserDeleteResponseRequestStatusStatusCodeInternalError              OrganizationTeamUserDeleteResponseRequestStatusStatusCode = "INTERNAL_ERROR"
	OrganizationTeamUserDeleteResponseRequestStatusStatusCodeInvalidRequest             OrganizationTeamUserDeleteResponseRequestStatusStatusCode = "INVALID_REQUEST"
	OrganizationTeamUserDeleteResponseRequestStatusStatusCodeInvalidRequestVersion      OrganizationTeamUserDeleteResponseRequestStatusStatusCode = "INVALID_REQUEST_VERSION"
	OrganizationTeamUserDeleteResponseRequestStatusStatusCodeInvalidRequestData         OrganizationTeamUserDeleteResponseRequestStatusStatusCode = "INVALID_REQUEST_DATA"
	OrganizationTeamUserDeleteResponseRequestStatusStatusCodeMethodNotAllowed           OrganizationTeamUserDeleteResponseRequestStatusStatusCode = "METHOD_NOT_ALLOWED"
	OrganizationTeamUserDeleteResponseRequestStatusStatusCodeConflict                   OrganizationTeamUserDeleteResponseRequestStatusStatusCode = "CONFLICT"
	OrganizationTeamUserDeleteResponseRequestStatusStatusCodeUnprocessableEntity        OrganizationTeamUserDeleteResponseRequestStatusStatusCode = "UNPROCESSABLE_ENTITY"
	OrganizationTeamUserDeleteResponseRequestStatusStatusCodeTooManyRequests            OrganizationTeamUserDeleteResponseRequestStatusStatusCode = "TOO_MANY_REQUESTS"
	OrganizationTeamUserDeleteResponseRequestStatusStatusCodeInsufficientStorage        OrganizationTeamUserDeleteResponseRequestStatusStatusCode = "INSUFFICIENT_STORAGE"
	OrganizationTeamUserDeleteResponseRequestStatusStatusCodeServiceUnavailable         OrganizationTeamUserDeleteResponseRequestStatusStatusCode = "SERVICE_UNAVAILABLE"
	OrganizationTeamUserDeleteResponseRequestStatusStatusCodePayloadTooLarge            OrganizationTeamUserDeleteResponseRequestStatusStatusCode = "PAYLOAD_TOO_LARGE"
	OrganizationTeamUserDeleteResponseRequestStatusStatusCodeNotAcceptable              OrganizationTeamUserDeleteResponseRequestStatusStatusCode = "NOT_ACCEPTABLE"
	OrganizationTeamUserDeleteResponseRequestStatusStatusCodeUnavailableForLegalReasons OrganizationTeamUserDeleteResponseRequestStatusStatusCode = "UNAVAILABLE_FOR_LEGAL_REASONS"
	OrganizationTeamUserDeleteResponseRequestStatusStatusCodeBadGateway                 OrganizationTeamUserDeleteResponseRequestStatusStatusCode = "BAD_GATEWAY"
)

func (OrganizationTeamUserDeleteResponseRequestStatusStatusCode) IsKnown 

func (r OrganizationTeamUserDeleteResponseRequestStatusStatusCode) IsKnown() bool

type OrganizationTeamUserGetParams 

type OrganizationTeamUserGetParams struct {
	// If the IDP ID is provided then it is used instead of the one configured for the
	// organization. If no IDP is configured for the organization, then IDP is guessed
	// based on the email domain
	IdpID param.Field[string] `query:"idp-id"`
}

func (OrganizationTeamUserGetParams) URLQuery 

func (r OrganizationTeamUserGetParams) URLQuery() (v url.Values)

URLQuery serializes OrganizationTeamUserGetParams's query parameters as `url.Values`.

type OrganizationTeamUserListParams 

type OrganizationTeamUserListParams struct {
	// The page number of result
	PageNumber param.Field[int64] `query:"page-number"`
	// The page size of result
	PageSize param.Field[int64] `query:"page-size"`
	// User Search Parameters. Only 'filters' and 'orderBy' for 'name' and 'email' are
	// implemented
	Q param.Field[OrganizationTeamUserListParamsQ] `query:"q"`
}

func (OrganizationTeamUserListParams) URLQuery 

func (r OrganizationTeamUserListParams) URLQuery() (v url.Values)

URLQuery serializes OrganizationTeamUserListParams's query parameters as `url.Values`.

type OrganizationTeamUserListParamsQ 

type OrganizationTeamUserListParamsQ struct {
	Fields      param.Field[[]string]                                 `query:"fields"`
	Filters     param.Field[[]OrganizationTeamUserListParamsQFilter]  `query:"filters"`
	GroupBy     param.Field[string]                                   `query:"groupBy"`
	OrderBy     param.Field[[]OrganizationTeamUserListParamsQOrderBy] `query:"orderBy"`
	Page        param.Field[int64]                                    `query:"page"`
	PageSize    param.Field[int64]                                    `query:"pageSize"`
	Query       param.Field[string]                                   `query:"query"`
	QueryFields param.Field[[]string]                                 `query:"queryFields"`
	ScoredSize  param.Field[int64]                                    `query:"scoredSize"`
}

User Search Parameters. Only 'filters' and 'orderBy' for 'name' and 'email' are implemented

func (OrganizationTeamUserListParamsQ) URLQuery 

func (r OrganizationTeamUserListParamsQ) URLQuery() (v url.Values)

URLQuery serializes OrganizationTeamUserListParamsQ's query parameters as `url.Values`.

type OrganizationTeamUserListParamsQFilter 

type OrganizationTeamUserListParamsQFilter struct {
	Field param.Field[string] `query:"field"`
	Value param.Field[string] `query:"value"`
}

func (OrganizationTeamUserListParamsQFilter) URLQuery 

func (r OrganizationTeamUserListParamsQFilter) URLQuery() (v url.Values)

URLQuery serializes OrganizationTeamUserListParamsQFilter's query parameters as `url.Values`.

type OrganizationTeamUserListParamsQOrderBy 

type OrganizationTeamUserListParamsQOrderBy struct {
	Field param.Field[string]                                      `query:"field"`
	Value param.Field[OrganizationTeamUserListParamsQOrderByValue] `query:"value"`
}

func (OrganizationTeamUserListParamsQOrderBy) URLQuery 

func (r OrganizationTeamUserListParamsQOrderBy) URLQuery() (v url.Values)

URLQuery serializes OrganizationTeamUserListParamsQOrderBy's query parameters as `url.Values`.

type OrganizationTeamUserListParamsQOrderByValue 

type OrganizationTeamUserListParamsQOrderByValue string
const (
	OrganizationTeamUserListParamsQOrderByValueAsc  OrganizationTeamUserListParamsQOrderByValue = "ASC"
	OrganizationTeamUserListParamsQOrderByValueDesc OrganizationTeamUserListParamsQOrderByValue = "DESC"
)

func (OrganizationTeamUserListParamsQOrderByValue) IsKnown 

func (r OrganizationTeamUserListParamsQOrderByValue) IsKnown() bool

type OrganizationTeamUserListResponse 

type OrganizationTeamUserListResponse struct {
	// unique Id of this user.
	ID int64 `json:"id"`
	// unique auth client id of this user.
	ClientID string `json:"clientId"`
	// Created date for this user
	CreatedDate string `json:"createdDate"`
	// Email address of the user. This should be unique.
	Email string `json:"email"`
	// Last time the user logged in
	FirstLoginDate string `json:"firstLoginDate"`
	// Determines if the user has beta access
	HasBetaAccess bool `json:"hasBetaAccess"`
	// indicate if user profile has been completed.
	HasProfile bool `json:"hasProfile"`
	// indicates if user has accepted AI Foundry Partnerships eula
	HasSignedAIFoundryPartnershipsEula bool `json:"hasSignedAiFoundryPartnershipsEULA"`
	// indicates if user has accepted Base Command End User License Agreement.
	HasSignedBaseCommandEula bool `json:"hasSignedBaseCommandEULA"`
	// indicates if user has accepted Base Command Manager End User License Agreement.
	HasSignedBaseCommandManagerEula bool `json:"hasSignedBaseCommandManagerEULA"`
	// indicates if user has accepted BioNeMo End User License Agreement.
	HasSignedBioNeMoEula bool `json:"hasSignedBioNeMoEULA"`
	// indicates if user has accepted container publishing eula
	HasSignedContainerPublishingEula bool `json:"hasSignedContainerPublishingEULA"`
	// indicates if user has accepted CuOpt eula
	HasSignedCuOptEula bool `json:"hasSignedCuOptEULA"`
	// indicates if user has accepted Earth-2 eula
	HasSignedEarth2Eula bool `json:"hasSignedEarth2EULA"`
	// [Deprecated] indicates if user has accepted EGX End User License Agreement.
	HasSignedEgxEula bool `json:"hasSignedEgxEULA"`
	// Determines if the user has signed the NGC End User License Agreement.
	HasSignedEula bool `json:"hasSignedEULA"`
	// indicates if user has accepted Fleet Command End User License Agreement.
	HasSignedFleetCommandEula bool `json:"hasSignedFleetCommandEULA"`
	// indicates if user has accepted LLM End User License Agreement.
	HasSignedLlmEula bool `json:"hasSignedLlmEULA"`
	// indicates if user has accepted Fleet Command End User License Agreement.
	HasSignedNvaieeula bool `json:"hasSignedNVAIEEULA"`
	// Determines if the user has signed the NVIDIA End User License Agreement.
	HasSignedNvidiaEula bool `json:"hasSignedNvidiaEULA"`
	// indicates if user has accepted Nvidia Quantum Cloud End User License Agreement.
	HasSignedNvqceula bool `json:"hasSignedNVQCEULA"`
	// indicates if user has accepted Omniverse End User License Agreement.
	HasSignedOmniverseEula bool `json:"hasSignedOmniverseEULA"`
	// Determines if the user has signed the Privacy Policy.
	HasSignedPrivacyPolicy bool `json:"hasSignedPrivacyPolicy"`
	// indicates if user has consented to share their registration info with other
	// parties
	HasSignedThirdPartyRegistryShareEula bool `json:"hasSignedThirdPartyRegistryShareEULA"`
	// Determines if the user has opted in email subscription.
	HasSubscribedToEmail bool `json:"hasSubscribedToEmail"`
	// Type of IDP, Identity Provider. Used for login.
	IdpType OrganizationTeamUserListResponseIdpType `json:"idpType"`
	// Determines if the user is active or not.
	IsActive bool `json:"isActive"`
	// Indicates if user was deleted from the system.
	IsDeleted bool `json:"isDeleted"`
	// Determines if the user is a SAML account or not.
	IsSAML bool `json:"isSAML"`
	// Title of user's job position.
	JobPositionTitle string `json:"jobPositionTitle"`
	// Last time the user logged in
	LastLoginDate string `json:"lastLoginDate"`
	// user name
	Name string `json:"name"`
	// List of roles that the user have
	Roles []OrganizationTeamUserListResponseRole `json:"roles"`
	// unique starfleet id of this user.
	StarfleetID string `json:"starfleetId"`
	// Storage quota for this user.
	StorageQuota []OrganizationTeamUserListResponseStorageQuota `json:"storageQuota"`
	// Updated date for this user
	UpdatedDate string `json:"updatedDate"`
	// Metadata information about the user.
	UserMetadata OrganizationTeamUserListResponseUserMetadata `json:"userMetadata"`
	JSON         organizationTeamUserListResponseJSON         `json:"-"`
}

information about the user

func (*OrganizationTeamUserListResponse) UnmarshalJSON 

func (r *OrganizationTeamUserListResponse) UnmarshalJSON(data []byte) (err error)

type OrganizationTeamUserListResponseIdpType 

type OrganizationTeamUserListResponseIdpType string

Type of IDP, Identity Provider. Used for login. 

const (
	OrganizationTeamUserListResponseIdpTypeNvidia     OrganizationTeamUserListResponseIdpType = "NVIDIA"
	OrganizationTeamUserListResponseIdpTypeEnterprise OrganizationTeamUserListResponseIdpType = "ENTERPRISE"
)

func (OrganizationTeamUserListResponseIdpType) IsKnown 

func (r OrganizationTeamUserListResponseIdpType) IsKnown() bool

type OrganizationTeamUserListResponseRole 

type OrganizationTeamUserListResponseRole struct {
	// Information about the Organization
	Org OrganizationTeamUserListResponseRolesOrg `json:"org"`
	// List of org role types that the user have
	OrgRoles []string `json:"orgRoles"`
	// DEPRECATED - List of role types that the user have
	RoleTypes []string `json:"roleTypes"`
	// Information about the user who is attempting to run the job
	TargetSystemUserIdentifier OrganizationTeamUserListResponseRolesTargetSystemUserIdentifier `json:"targetSystemUserIdentifier"`
	// Information about the team
	Team OrganizationTeamUserListResponseRolesTeam `json:"team"`
	// List of team role types that the user have
	TeamRoles []string                                 `json:"teamRoles"`
	JSON      organizationTeamUserListResponseRoleJSON `json:"-"`
}

List of roles that the user have

func (*OrganizationTeamUserListResponseRole) UnmarshalJSON 

func (r *OrganizationTeamUserListResponseRole) UnmarshalJSON(data []byte) (err error)

type OrganizationTeamUserListResponseRolesOrg 

type OrganizationTeamUserListResponseRolesOrg struct {
	// Unique Id of this team.
	ID int64 `json:"id"`
	// Org Owner Alternate Contact
	AlternateContact OrganizationTeamUserListResponseRolesOrgAlternateContact `json:"alternateContact"`
	// Billing account ID.
	BillingAccountID string `json:"billingAccountId"`
	// Identifies if the org can be reused.
	CanAddOn bool `json:"canAddOn"`
	// ISO country code of the organization.
	Country string `json:"country"`
	// Optional description of the organization.
	Description string `json:"description"`
	// Name of the organization that will be shown to users.
	DisplayName string `json:"displayName"`
	// Identity Provider ID.
	IdpID string `json:"idpId"`
	// Industry of the organization.
	Industry string `json:"industry"`
	// Infinity manager setting definition
	InfinityManagerSettings OrganizationTeamUserListResponseRolesOrgInfinityManagerSettings `json:"infinityManagerSettings"`
	// Dataset Service enable flag for an organization
	IsDatasetServiceEnabled bool `json:"isDatasetServiceEnabled"`
	// Is NVIDIA internal org or not
	IsInternal bool `json:"isInternal"`
	// Indicates when the org is a proto org
	IsProto bool `json:"isProto"`
	// Quick Start enable flag for an organization
	IsQuickStartEnabled bool `json:"isQuickStartEnabled"`
	// If a server side encryption is enabled for private registry (models, resources)
	IsRegistrySseEnabled bool `json:"isRegistrySSEEnabled"`
	// Secrets Manager Service enable flag for an organization
	IsSecretsManagerServiceEnabled bool `json:"isSecretsManagerServiceEnabled"`
	// Secure Credential Sharing Service enable flag for an organization
	IsSecureCredentialSharingServiceEnabled bool `json:"isSecureCredentialSharingServiceEnabled"`
	// If a separate influx db used for an organization in BCP for job telemetry
	IsSeparateInfluxDBUsed bool `json:"isSeparateInfluxDbUsed"`
	// Organization name.
	Name string `json:"name"`
	// NVIDIA Cloud Account Number.
	Nan string `json:"nan"`
	// Org owner.
	OrgOwner OrganizationTeamUserListResponseRolesOrgOrgOwner `json:"orgOwner"`
	// Org owners
	OrgOwners []OrganizationTeamUserListResponseRolesOrgOrgOwner `json:"orgOwners"`
	// Product end customer salesforce.com Id (external customer Id). pecSfdcId is for
	// EMS (entitlement management service) to track external paid customer.
	PecSfdcID            string                                                        `json:"pecSfdcId"`
	ProductEnablements   []OrganizationTeamUserListResponseRolesOrgProductEnablement   `json:"productEnablements"`
	ProductSubscriptions []OrganizationTeamUserListResponseRolesOrgProductSubscription `json:"productSubscriptions"`
	// Repo scan setting definition
	RepoScanSettings OrganizationTeamUserListResponseRolesOrgRepoScanSettings `json:"repoScanSettings"`
	Type             OrganizationTeamUserListResponseRolesOrgType             `json:"type"`
	// Users information.
	UsersInfo OrganizationTeamUserListResponseRolesOrgUsersInfo `json:"usersInfo"`
	JSON      organizationTeamUserListResponseRolesOrgJSON      `json:"-"`
}

Information about the Organization

func (*OrganizationTeamUserListResponseRolesOrg) UnmarshalJSON 

func (r *OrganizationTeamUserListResponseRolesOrg) UnmarshalJSON(data []byte) (err error)

type OrganizationTeamUserListResponseRolesOrgAlternateContact 

type OrganizationTeamUserListResponseRolesOrgAlternateContact struct {
	// Alternate contact's email.
	Email string `json:"email"`
	// Full name of the alternate contact.
	FullName string                                                       `json:"fullName"`
	JSON     organizationTeamUserListResponseRolesOrgAlternateContactJSON `json:"-"`
}

Org Owner Alternate Contact

func (*OrganizationTeamUserListResponseRolesOrgAlternateContact) UnmarshalJSON 

func (r *OrganizationTeamUserListResponseRolesOrgAlternateContact) UnmarshalJSON(data []byte) (err error)

type OrganizationTeamUserListResponseRolesOrgInfinityManagerSettings 

type OrganizationTeamUserListResponseRolesOrgInfinityManagerSettings struct {
	// Enable the infinity manager or not. Used both in org and team level object
	InfinityManagerEnabled bool `json:"infinityManagerEnabled"`
	// Allow override settings at team level. Only used in org level object
	InfinityManagerEnableTeamOverride bool                                                                `json:"infinityManagerEnableTeamOverride"`
	JSON                              organizationTeamUserListResponseRolesOrgInfinityManagerSettingsJSON `json:"-"`
}

Infinity manager setting definition

func (*OrganizationTeamUserListResponseRolesOrgInfinityManagerSettings) UnmarshalJSON 

func (r *OrganizationTeamUserListResponseRolesOrgInfinityManagerSettings) UnmarshalJSON(data []byte) (err error)

type OrganizationTeamUserListResponseRolesOrgOrgOwner 

type OrganizationTeamUserListResponseRolesOrgOrgOwner struct {
	// Email address of the org owner.
	Email string `json:"email,required"`
	// Org owner name.
	FullName string `json:"fullName,required"`
	// Last time the org owner logged in.
	LastLoginDate string                                               `json:"lastLoginDate"`
	JSON          organizationTeamUserListResponseRolesOrgOrgOwnerJSON `json:"-"`
}

Org owner.

func (*OrganizationTeamUserListResponseRolesOrgOrgOwner) UnmarshalJSON 

func (r *OrganizationTeamUserListResponseRolesOrgOrgOwner) UnmarshalJSON(data []byte) (err error)

type OrganizationTeamUserListResponseRolesOrgProductEnablement 

type OrganizationTeamUserListResponseRolesOrgProductEnablement struct {
	// Product Name (NVAIE, BASE_COMMAND, REGISTRY, etc)
	ProductName string `json:"productName,required"`
	// Product Enablement Types
	Type OrganizationTeamUserListResponseRolesOrgProductEnablementsType `json:"type,required"`
	// Date on which the subscription expires. The subscription is invalid after this
	// date. (yyyy-MM-dd)
	ExpirationDate string                                                               `json:"expirationDate"`
	PoDetails      []OrganizationTeamUserListResponseRolesOrgProductEnablementsPoDetail `json:"poDetails"`
	JSON           organizationTeamUserListResponseRolesOrgProductEnablementJSON        `json:"-"`
}

Product Enablement

func (*OrganizationTeamUserListResponseRolesOrgProductEnablement) UnmarshalJSON 

func (r *OrganizationTeamUserListResponseRolesOrgProductEnablement) UnmarshalJSON(data []byte) (err error)

type OrganizationTeamUserListResponseRolesOrgProductEnablementsPoDetail 

type OrganizationTeamUserListResponseRolesOrgProductEnablementsPoDetail struct {
	// Entitlement identifier.
	EntitlementID string `json:"entitlementId"`
	// PAK (Product Activation Key) identifier.
	PkID string                                                                 `json:"pkId"`
	JSON organizationTeamUserListResponseRolesOrgProductEnablementsPoDetailJSON `json:"-"`
}

Purchase Order.

func (*OrganizationTeamUserListResponseRolesOrgProductEnablementsPoDetail) UnmarshalJSON 

func (r *OrganizationTeamUserListResponseRolesOrgProductEnablementsPoDetail) UnmarshalJSON(data []byte) (err error)

type OrganizationTeamUserListResponseRolesOrgProductEnablementsType 

type OrganizationTeamUserListResponseRolesOrgProductEnablementsType string

Product Enablement Types 

const (
	OrganizationTeamUserListResponseRolesOrgProductEnablementsTypeNgcAdminEval       OrganizationTeamUserListResponseRolesOrgProductEnablementsType = "NGC_ADMIN_EVAL"
	OrganizationTeamUserListResponseRolesOrgProductEnablementsTypeNgcAdminNfr        OrganizationTeamUserListResponseRolesOrgProductEnablementsType = "NGC_ADMIN_NFR"
	OrganizationTeamUserListResponseRolesOrgProductEnablementsTypeNgcAdminCommercial OrganizationTeamUserListResponseRolesOrgProductEnablementsType = "NGC_ADMIN_COMMERCIAL"
	OrganizationTeamUserListResponseRolesOrgProductEnablementsTypeEmsEval            OrganizationTeamUserListResponseRolesOrgProductEnablementsType = "EMS_EVAL"
	OrganizationTeamUserListResponseRolesOrgProductEnablementsTypeEmsNfr             OrganizationTeamUserListResponseRolesOrgProductEnablementsType = "EMS_NFR"
	OrganizationTeamUserListResponseRolesOrgProductEnablementsTypeEmsCommercial      OrganizationTeamUserListResponseRolesOrgProductEnablementsType = "EMS_COMMERCIAL"
	OrganizationTeamUserListResponseRolesOrgProductEnablementsTypeNgcAdminDeveloper  OrganizationTeamUserListResponseRolesOrgProductEnablementsType = "NGC_ADMIN_DEVELOPER"
)

func (OrganizationTeamUserListResponseRolesOrgProductEnablementsType) IsKnown 

func (r OrganizationTeamUserListResponseRolesOrgProductEnablementsType) IsKnown() bool

type OrganizationTeamUserListResponseRolesOrgProductSubscription 

type OrganizationTeamUserListResponseRolesOrgProductSubscription struct {
	// Product Name (NVAIE, BASE_COMMAND, FleetCommand, REGISTRY, etc).
	ProductName string `json:"productName,required"`
	// Unique entitlement identifier
	ID string `json:"id"`
	// EMS Subscription type. (options: EMS_EVAL, EMS_NFR and EMS_COMMERCIAL)
	EmsEntitlementType OrganizationTeamUserListResponseRolesOrgProductSubscriptionsEmsEntitlementType `json:"emsEntitlementType"`
	// Date on which the subscription expires. The subscription is invalid after this
	// date. (yyyy-MM-dd)
	ExpirationDate string `json:"expirationDate"`
	// Date on which the subscription becomes active. (yyyy-MM-dd)
	StartDate string `json:"startDate"`
	// Subscription type. (options: NGC_ADMIN_EVAL, NGC_ADMIN_NFR,
	// NGC_ADMIN_COMMERCIAL)
	Type OrganizationTeamUserListResponseRolesOrgProductSubscriptionsType `json:"type"`
	JSON organizationTeamUserListResponseRolesOrgProductSubscriptionJSON  `json:"-"`
}

Product Subscription

func (*OrganizationTeamUserListResponseRolesOrgProductSubscription) UnmarshalJSON 

func (r *OrganizationTeamUserListResponseRolesOrgProductSubscription) UnmarshalJSON(data []byte) (err error)

type OrganizationTeamUserListResponseRolesOrgProductSubscriptionsEmsEntitlementType 

type OrganizationTeamUserListResponseRolesOrgProductSubscriptionsEmsEntitlementType string

EMS Subscription type. (options: EMS_EVAL, EMS_NFR and EMS_COMMERCIAL) 

const (
	OrganizationTeamUserListResponseRolesOrgProductSubscriptionsEmsEntitlementTypeEmsEval       OrganizationTeamUserListResponseRolesOrgProductSubscriptionsEmsEntitlementType = "EMS_EVAL"
	OrganizationTeamUserListResponseRolesOrgProductSubscriptionsEmsEntitlementTypeEmsNfr        OrganizationTeamUserListResponseRolesOrgProductSubscriptionsEmsEntitlementType = "EMS_NFR"
	OrganizationTeamUserListResponseRolesOrgProductSubscriptionsEmsEntitlementTypeEmsCommerical OrganizationTeamUserListResponseRolesOrgProductSubscriptionsEmsEntitlementType = "EMS_COMMERICAL"
	OrganizationTeamUserListResponseRolesOrgProductSubscriptionsEmsEntitlementTypeEmsCommercial OrganizationTeamUserListResponseRolesOrgProductSubscriptionsEmsEntitlementType = "EMS_COMMERCIAL"
)

func (OrganizationTeamUserListResponseRolesOrgProductSubscriptionsEmsEntitlementType) IsKnown 

func (r OrganizationTeamUserListResponseRolesOrgProductSubscriptionsEmsEntitlementType) IsKnown() bool

type OrganizationTeamUserListResponseRolesOrgProductSubscriptionsType 

type OrganizationTeamUserListResponseRolesOrgProductSubscriptionsType string

Subscription type. (options: NGC_ADMIN_EVAL, NGC_ADMIN_NFR, NGC_ADMIN_COMMERCIAL) 

const (
	OrganizationTeamUserListResponseRolesOrgProductSubscriptionsTypeNgcAdminEval       OrganizationTeamUserListResponseRolesOrgProductSubscriptionsType = "NGC_ADMIN_EVAL"
	OrganizationTeamUserListResponseRolesOrgProductSubscriptionsTypeNgcAdminNfr        OrganizationTeamUserListResponseRolesOrgProductSubscriptionsType = "NGC_ADMIN_NFR"
	OrganizationTeamUserListResponseRolesOrgProductSubscriptionsTypeNgcAdminCommercial OrganizationTeamUserListResponseRolesOrgProductSubscriptionsType = "NGC_ADMIN_COMMERCIAL"
)

func (OrganizationTeamUserListResponseRolesOrgProductSubscriptionsType) IsKnown 

func (r OrganizationTeamUserListResponseRolesOrgProductSubscriptionsType) IsKnown() bool

type OrganizationTeamUserListResponseRolesOrgRepoScanSettings 

type OrganizationTeamUserListResponseRolesOrgRepoScanSettings struct {
	// Allow org admin to override the org level repo scan settings
	RepoScanAllowOverride bool `json:"repoScanAllowOverride"`
	// Allow repository scanning by default
	RepoScanByDefault bool `json:"repoScanByDefault"`
	// Enable the repository scan or not. Only used in org level object
	RepoScanEnabled bool `json:"repoScanEnabled"`
	// Sends notification to end user after scanning is done
	RepoScanEnableNotifications bool `json:"repoScanEnableNotifications"`
	// Allow override settings at team level. Only used in org level object
	RepoScanEnableTeamOverride bool `json:"repoScanEnableTeamOverride"`
	// Allow showing scan results to CLI or UI
	RepoScanShowResults bool                                                         `json:"repoScanShowResults"`
	JSON                organizationTeamUserListResponseRolesOrgRepoScanSettingsJSON `json:"-"`
}

Repo scan setting definition

func (*OrganizationTeamUserListResponseRolesOrgRepoScanSettings) UnmarshalJSON 

func (r *OrganizationTeamUserListResponseRolesOrgRepoScanSettings) UnmarshalJSON(data []byte) (err error)

type OrganizationTeamUserListResponseRolesOrgType 

type OrganizationTeamUserListResponseRolesOrgType string
const (
	OrganizationTeamUserListResponseRolesOrgTypeUnknown    OrganizationTeamUserListResponseRolesOrgType = "UNKNOWN"
	OrganizationTeamUserListResponseRolesOrgTypeCloud      OrganizationTeamUserListResponseRolesOrgType = "CLOUD"
	OrganizationTeamUserListResponseRolesOrgTypeEnterprise OrganizationTeamUserListResponseRolesOrgType = "ENTERPRISE"
	OrganizationTeamUserListResponseRolesOrgTypeIndividual OrganizationTeamUserListResponseRolesOrgType = "INDIVIDUAL"
)

func (OrganizationTeamUserListResponseRolesOrgType) IsKnown 

func (r OrganizationTeamUserListResponseRolesOrgType) IsKnown() bool

type OrganizationTeamUserListResponseRolesOrgUsersInfo 

type OrganizationTeamUserListResponseRolesOrgUsersInfo struct {
	// Total number of users.
	TotalUsers int64                                                 `json:"totalUsers"`
	JSON       organizationTeamUserListResponseRolesOrgUsersInfoJSON `json:"-"`
}

Users information.

func (*OrganizationTeamUserListResponseRolesOrgUsersInfo) UnmarshalJSON 

func (r *OrganizationTeamUserListResponseRolesOrgUsersInfo) UnmarshalJSON(data []byte) (err error)

type OrganizationTeamUserListResponseRolesTargetSystemUserIdentifier 

type OrganizationTeamUserListResponseRolesTargetSystemUserIdentifier struct {
	// gid of the user on this team
	Gid int64 `json:"gid"`
	// Org context for the job
	OrgName string `json:"orgName"`
	// Starfleet ID of the user creating the job.
	StarfleetID string `json:"starfleetId"`
	// Team context for the job
	TeamName string `json:"teamName"`
	// uid of the user on this team
	Uid int64 `json:"uid"`
	// Unique ID of the user who submitted the job
	UserID int64                                                               `json:"userId"`
	JSON   organizationTeamUserListResponseRolesTargetSystemUserIdentifierJSON `json:"-"`
}

Information about the user who is attempting to run the job

func (*OrganizationTeamUserListResponseRolesTargetSystemUserIdentifier) UnmarshalJSON 

func (r *OrganizationTeamUserListResponseRolesTargetSystemUserIdentifier) UnmarshalJSON(data []byte) (err error)

type OrganizationTeamUserListResponseRolesTeam 

type OrganizationTeamUserListResponseRolesTeam struct {
	// unique Id of this team.
	ID int64 `json:"id"`
	// description of the team
	Description string `json:"description"`
	// Infinity manager setting definition
	InfinityManagerSettings OrganizationTeamUserListResponseRolesTeamInfinityManagerSettings `json:"infinityManagerSettings"`
	// indicates if the team is deleted or not
	IsDeleted bool `json:"isDeleted"`
	// team name
	Name string `json:"name"`
	// Repo scan setting definition
	RepoScanSettings OrganizationTeamUserListResponseRolesTeamRepoScanSettings `json:"repoScanSettings"`
	JSON             organizationTeamUserListResponseRolesTeamJSON             `json:"-"`
}

Information about the team

func (*OrganizationTeamUserListResponseRolesTeam) UnmarshalJSON 

func (r *OrganizationTeamUserListResponseRolesTeam) UnmarshalJSON(data []byte) (err error)

type OrganizationTeamUserListResponseRolesTeamInfinityManagerSettings 

type OrganizationTeamUserListResponseRolesTeamInfinityManagerSettings struct {
	// Enable the infinity manager or not. Used both in org and team level object
	InfinityManagerEnabled bool `json:"infinityManagerEnabled"`
	// Allow override settings at team level. Only used in org level object
	InfinityManagerEnableTeamOverride bool                                                                 `json:"infinityManagerEnableTeamOverride"`
	JSON                              organizationTeamUserListResponseRolesTeamInfinityManagerSettingsJSON `json:"-"`
}

Infinity manager setting definition

func (*OrganizationTeamUserListResponseRolesTeamInfinityManagerSettings) UnmarshalJSON 

func (r *OrganizationTeamUserListResponseRolesTeamInfinityManagerSettings) UnmarshalJSON(data []byte) (err error)

type OrganizationTeamUserListResponseRolesTeamRepoScanSettings 

type OrganizationTeamUserListResponseRolesTeamRepoScanSettings struct {
	// Allow org admin to override the org level repo scan settings
	RepoScanAllowOverride bool `json:"repoScanAllowOverride"`
	// Allow repository scanning by default
	RepoScanByDefault bool `json:"repoScanByDefault"`
	// Enable the repository scan or not. Only used in org level object
	RepoScanEnabled bool `json:"repoScanEnabled"`
	// Sends notification to end user after scanning is done
	RepoScanEnableNotifications bool `json:"repoScanEnableNotifications"`
	// Allow override settings at team level. Only used in org level object
	RepoScanEnableTeamOverride bool `json:"repoScanEnableTeamOverride"`
	// Allow showing scan results to CLI or UI
	RepoScanShowResults bool                                                          `json:"repoScanShowResults"`
	JSON                organizationTeamUserListResponseRolesTeamRepoScanSettingsJSON `json:"-"`
}

Repo scan setting definition

func (*OrganizationTeamUserListResponseRolesTeamRepoScanSettings) UnmarshalJSON 

func (r *OrganizationTeamUserListResponseRolesTeamRepoScanSettings) UnmarshalJSON(data []byte) (err error)

type OrganizationTeamUserListResponseStorageQuota 

type OrganizationTeamUserListResponseStorageQuota struct {
	// id of the ace
	AceID int64 `json:"aceId"`
	// name of the ace
	AceName string `json:"aceName"`
	// Available space in bytes
	Available int64 `json:"available"`
	// Number of datasets that are a part of user's used storage
	DatasetCount int64 `json:"datasetCount"`
	// Space used by datasets in bytes
	DatasetsUsage int64 `json:"datasetsUsage"`
	// The org name that this user quota tied to. This is needed for analytics
	OrgName string `json:"orgName"`
	// Assigned quota in bytes
	Quota int64 `json:"quota"`
	// Number of resultsets that are a part of user's used storage
	ResultsetCount int64 `json:"resultsetCount"`
	// Space used by resultsets in bytes
	ResultsetsUsage int64 `json:"resultsetsUsage"`
	// Description of this storage cluster
	StorageClusterDescription string `json:"storageClusterDescription"`
	// Name of storage cluster
	StorageClusterName string `json:"storageClusterName"`
	// Identifier to this storage cluster
	StorageClusterUuid string `json:"storageClusterUuid"`
	// Number of workspaces that are a part of user's used storage
	WorkspacesCount int64 `json:"workspacesCount"`
	// Space used by workspaces in bytes
	WorkspacesUsage int64                                            `json:"workspacesUsage"`
	JSON            organizationTeamUserListResponseStorageQuotaJSON `json:"-"`
}

represents user storage quota for a given ace and available unused storage

func (*OrganizationTeamUserListResponseStorageQuota) UnmarshalJSON 

func (r *OrganizationTeamUserListResponseStorageQuota) UnmarshalJSON(data []byte) (err error)

type OrganizationTeamUserListResponseUserMetadata 

type OrganizationTeamUserListResponseUserMetadata struct {
	// Name of the company
	Company string `json:"company"`
	// Company URL
	CompanyURL string `json:"companyUrl"`
	// Country of the user
	Country string `json:"country"`
	// User's first name
	FirstName string `json:"firstName"`
	// Industry segment
	Industry string `json:"industry"`
	// List of development areas that user has interest
	Interest []string `json:"interest"`
	// User's last name
	LastName string `json:"lastName"`
	// Role of the user in the company
	Role string                                           `json:"role"`
	JSON organizationTeamUserListResponseUserMetadataJSON `json:"-"`
}

Metadata information about the user.

func (*OrganizationTeamUserListResponseUserMetadata) UnmarshalJSON 

func (r *OrganizationTeamUserListResponseUserMetadata) UnmarshalJSON(data []byte) (err error)

type OrganizationTeamUserNewParams 

type OrganizationTeamUserNewParams struct {
	// Email address of the user. This should be unique.
	Email param.Field[string] `json:"email,required"`
	// If the IDP ID is provided then it is used instead of the one configured for the
	// organization
	IdpID     param.Field[string] `query:"idp-id"`
	SendEmail param.Field[bool]   `query:"send-email"`
	// indicates if user has opt in to nvidia emails
	EmailOptIn param.Field[bool] `json:"emailOptIn"`
	// indicates if user has accepted EULA
	EulaAccepted param.Field[bool] `json:"eulaAccepted"`
	// user name
	Name param.Field[string] `json:"name"`
	// DEPRECATED - use roleTypes which allows multiple roles
	RoleType param.Field[string] `json:"roleType"`
	// feature roles to give to the user
	RoleTypes param.Field[[]string] `json:"roleTypes"`
	// user job role
	SalesforceContactJobRole param.Field[string] `json:"salesforceContactJobRole"`
	// Metadata information about the user.
	UserMetadata param.Field[OrganizationTeamUserNewParamsUserMetadata] `json:"userMetadata"`
	Ncid         param.Field[string]                                    `cookie:"ncid"`
	VisitorID    param.Field[string]                                    `cookie:"VisitorID"`
}

func (OrganizationTeamUserNewParams) MarshalJSON 

func (r OrganizationTeamUserNewParams) MarshalJSON() (data []byte, err error)

func (OrganizationTeamUserNewParams) URLQuery 

func (r OrganizationTeamUserNewParams) URLQuery() (v url.Values)

URLQuery serializes OrganizationTeamUserNewParams's query parameters as `url.Values`.

type OrganizationTeamUserNewParamsUserMetadata 

type OrganizationTeamUserNewParamsUserMetadata struct {
	// Name of the company
	Company param.Field[string] `json:"company"`
	// Company URL
	CompanyURL param.Field[string] `json:"companyUrl"`
	// Country of the user
	Country param.Field[string] `json:"country"`
	// User's first name
	FirstName param.Field[string] `json:"firstName"`
	// Industry segment
	Industry param.Field[string] `json:"industry"`
	// List of development areas that user has interest
	Interest param.Field[[]string] `json:"interest"`
	// User's last name
	LastName param.Field[string] `json:"lastName"`
	// Role of the user in the company
	Role param.Field[string] `json:"role"`
}

Metadata information about the user.

func (OrganizationTeamUserNewParamsUserMetadata) MarshalJSON 

func (r OrganizationTeamUserNewParamsUserMetadata) MarshalJSON() (data []byte, err error)

type OrganizationTeamUserService 

type OrganizationTeamUserService struct {
	Options []option.RequestOption
}

OrganizationTeamUserService contains methods and other services that help with interacting with the ngc API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewOrganizationTeamUserService method instead.

func NewOrganizationTeamUserService 

func NewOrganizationTeamUserService(opts ...option.RequestOption) (r *OrganizationTeamUserService)

NewOrganizationTeamUserService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*OrganizationTeamUserService) Delete 

func (r *OrganizationTeamUserService) Delete(ctx context.Context, orgName string, teamName string, id string, opts ...option.RequestOption) (res *OrganizationTeamUserDeleteResponse, err error)

Removes User from team. (Org Admin or Team Admin Privileges Required).

func (*OrganizationTeamUserService) Get 

func (r *OrganizationTeamUserService) Get(ctx context.Context, orgName string, teamName string, id string, query OrganizationTeamUserGetParams, opts ...option.RequestOption) (res *shared.User, err error)

Get User details within team context

func (*OrganizationTeamUserService) List 

func (r *OrganizationTeamUserService) List(ctx context.Context, orgName string, teamName string, query OrganizationTeamUserListParams, opts ...option.RequestOption) (res *pagination.PageNumberUsers[shared.OrganizationTeamUserListResponse], err error)

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

func (*OrganizationTeamUserService) ListAutoPaging 

func (r *OrganizationTeamUserService) ListAutoPaging(ctx context.Context, orgName string, teamName string, query OrganizationTeamUserListParams, opts ...option.RequestOption) *pagination.PageNumberUsersAutoPager[shared.OrganizationTeamUserListResponse]

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

func (*OrganizationTeamUserService) New 

func (r *OrganizationTeamUserService) New(ctx context.Context, orgName string, teamName string, params OrganizationTeamUserNewParams, opts ...option.RequestOption) (res *shared.User, err error)

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

type PublicKeyService 

type PublicKeyService struct {
	Options []option.RequestOption
}

PublicKeyService contains methods and other services that help with interacting with the ngc API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewPublicKeyService method instead.

func NewPublicKeyService 

func NewPublicKeyService(opts ...option.RequestOption) (r *PublicKeyService)

NewPublicKeyService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*PublicKeyService) GetAll 

func (r *PublicKeyService) GetAll(ctx context.Context, opts ...option.RequestOption) (res *[]string, err error)

Used to check the health status of the web service only

type RoleGetAllParams 

type RoleGetAllParams struct {
	// flag indicate if hidden roles should be included
	ShowHidden param.Field[bool] `query:"show-hidden"`
}

func (RoleGetAllParams) URLQuery 

func (r RoleGetAllParams) URLQuery() (v url.Values)

URLQuery serializes RoleGetAllParams's query parameters as `url.Values`.

type RoleService 

type RoleService struct {
	Options []option.RequestOption
}

RoleService contains methods and other services that help with interacting with the ngc API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewRoleService method instead.

func NewRoleService 

func NewRoleService(opts ...option.RequestOption) (r *RoleService)

NewRoleService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*RoleService) GetAll 

func (r *RoleService) GetAll(ctx context.Context, query RoleGetAllParams, opts ...option.RequestOption) (res *UserRoleDefinitions, err error)

List of roles in NGC and their scopes

type ServiceService 

type ServiceService struct {
	Options []option.RequestOption
}

ServiceService contains methods and other services that help with interacting with the ngc API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewServiceService method instead.

func NewServiceService 

func NewServiceService(opts ...option.RequestOption) (r *ServiceService)

NewServiceService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*ServiceService) Version 

func (r *ServiceService) Version(ctx context.Context, query ServiceVersionParams, opts ...option.RequestOption) (res *ServiceVersionResponse, err error)

Used to get the latest version number of a given package.

type ServiceVersionParams 

type ServiceVersionParams struct {
	// name of package
	Package param.Field[string] `query:"package"`
	// repository of package
	Repo param.Field[string] `query:"repo"`
}

func (ServiceVersionParams) URLQuery 

func (r ServiceVersionParams) URLQuery() (v url.Values)

URLQuery serializes ServiceVersionParams's query parameters as `url.Values`.

type ServiceVersionResponse 

type ServiceVersionResponse struct {
	RequestStatus ServiceVersionResponseRequestStatus `json:"requestStatus"`
	Versions      []ServiceVersionResponseVersion     `json:"versions"`
	JSON          serviceVersionResponseJSON          `json:"-"`
}

an array of versions

func (*ServiceVersionResponse) UnmarshalJSON 

func (r *ServiceVersionResponse) UnmarshalJSON(data []byte) (err error)

type ServiceVersionResponseRequestStatus 

type ServiceVersionResponseRequestStatus struct {
	RequestID string `json:"requestId"`
	ServerID  string `json:"serverId"`
	// Describes response status reported by the server.
	StatusCode        ServiceVersionResponseRequestStatusStatusCode `json:"statusCode"`
	StatusDescription string                                        `json:"statusDescription"`
	JSON              serviceVersionResponseRequestStatusJSON       `json:"-"`
}

func (*ServiceVersionResponseRequestStatus) UnmarshalJSON 

func (r *ServiceVersionResponseRequestStatus) UnmarshalJSON(data []byte) (err error)

type ServiceVersionResponseRequestStatusStatusCode 

type ServiceVersionResponseRequestStatusStatusCode string

Describes response status reported by the server. 

const (
	ServiceVersionResponseRequestStatusStatusCodeUnknown                    ServiceVersionResponseRequestStatusStatusCode = "UNKNOWN"
	ServiceVersionResponseRequestStatusStatusCodeSuccess                    ServiceVersionResponseRequestStatusStatusCode = "SUCCESS"
	ServiceVersionResponseRequestStatusStatusCodeUnauthorized               ServiceVersionResponseRequestStatusStatusCode = "UNAUTHORIZED"
	ServiceVersionResponseRequestStatusStatusCodePaymentRequired            ServiceVersionResponseRequestStatusStatusCode = "PAYMENT_REQUIRED"
	ServiceVersionResponseRequestStatusStatusCodeForbidden                  ServiceVersionResponseRequestStatusStatusCode = "FORBIDDEN"
	ServiceVersionResponseRequestStatusStatusCodeTimeout                    ServiceVersionResponseRequestStatusStatusCode = "TIMEOUT"
	ServiceVersionResponseRequestStatusStatusCodeExists                     ServiceVersionResponseRequestStatusStatusCode = "EXISTS"
	ServiceVersionResponseRequestStatusStatusCodeNotFound                   ServiceVersionResponseRequestStatusStatusCode = "NOT_FOUND"
	ServiceVersionResponseRequestStatusStatusCodeInternalError              ServiceVersionResponseRequestStatusStatusCode = "INTERNAL_ERROR"
	ServiceVersionResponseRequestStatusStatusCodeInvalidRequest             ServiceVersionResponseRequestStatusStatusCode = "INVALID_REQUEST"
	ServiceVersionResponseRequestStatusStatusCodeInvalidRequestVersion      ServiceVersionResponseRequestStatusStatusCode = "INVALID_REQUEST_VERSION"
	ServiceVersionResponseRequestStatusStatusCodeInvalidRequestData         ServiceVersionResponseRequestStatusStatusCode = "INVALID_REQUEST_DATA"
	ServiceVersionResponseRequestStatusStatusCodeMethodNotAllowed           ServiceVersionResponseRequestStatusStatusCode = "METHOD_NOT_ALLOWED"
	ServiceVersionResponseRequestStatusStatusCodeConflict                   ServiceVersionResponseRequestStatusStatusCode = "CONFLICT"
	ServiceVersionResponseRequestStatusStatusCodeUnprocessableEntity        ServiceVersionResponseRequestStatusStatusCode = "UNPROCESSABLE_ENTITY"
	ServiceVersionResponseRequestStatusStatusCodeTooManyRequests            ServiceVersionResponseRequestStatusStatusCode = "TOO_MANY_REQUESTS"
	ServiceVersionResponseRequestStatusStatusCodeInsufficientStorage        ServiceVersionResponseRequestStatusStatusCode = "INSUFFICIENT_STORAGE"
	ServiceVersionResponseRequestStatusStatusCodeServiceUnavailable         ServiceVersionResponseRequestStatusStatusCode = "SERVICE_UNAVAILABLE"
	ServiceVersionResponseRequestStatusStatusCodePayloadTooLarge            ServiceVersionResponseRequestStatusStatusCode = "PAYLOAD_TOO_LARGE"
	ServiceVersionResponseRequestStatusStatusCodeNotAcceptable              ServiceVersionResponseRequestStatusStatusCode = "NOT_ACCEPTABLE"
	ServiceVersionResponseRequestStatusStatusCodeUnavailableForLegalReasons ServiceVersionResponseRequestStatusStatusCode = "UNAVAILABLE_FOR_LEGAL_REASONS"
	ServiceVersionResponseRequestStatusStatusCodeBadGateway                 ServiceVersionResponseRequestStatusStatusCode = "BAD_GATEWAY"
)

func (ServiceVersionResponseRequestStatusStatusCode) IsKnown 

func (r ServiceVersionResponseRequestStatusStatusCode) IsKnown() bool

type ServiceVersionResponseVersion 

type ServiceVersionResponseVersion struct {
	// The creation date of the version
	CreatedAt string `json:"createdAt"`
	// Human readable description of the package
	Description string `json:"description"`
	// The name of the package
	Name string `json:"name"`
	// The version number
	Version string                            `json:"version"`
	JSON    serviceVersionResponseVersionJSON `json:"-"`
}

Latest version information for a specific package

func (*ServiceVersionResponseVersion) UnmarshalJSON 

func (r *ServiceVersionResponseVersion) UnmarshalJSON(data []byte) (err error)

type SuperAdminOrgControllerOrgService 

type SuperAdminOrgControllerOrgService struct {
	Options []option.RequestOption
}

SuperAdminOrgControllerOrgService contains methods and other services that help with interacting with the ngc API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewSuperAdminOrgControllerOrgService method instead.

func NewSuperAdminOrgControllerOrgService 

func NewSuperAdminOrgControllerOrgService(opts ...option.RequestOption) (r *SuperAdminOrgControllerOrgService)

NewSuperAdminOrgControllerOrgService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*SuperAdminOrgControllerOrgService) Get 

func (r *SuperAdminOrgControllerOrgService) Get(ctx context.Context, orgName string, opts ...option.RequestOption) (res *http.Response, err error)

Get organization or proto organization info. (SuperAdmin privileges required)

func (*SuperAdminOrgControllerOrgService) Update 

func (r *SuperAdminOrgControllerOrgService) Update(ctx context.Context, orgName string, body SuperAdminOrgControllerOrgUpdateParams, opts ...option.RequestOption) (res *http.Response, err error)

Update org information and settings. Superadmin privileges required

type SuperAdminOrgControllerOrgUpdateParams 

type SuperAdminOrgControllerOrgUpdateParams struct {
	// Org Owner Alternate Contact
	AlternateContact param.Field[SuperAdminOrgControllerOrgUpdateParamsAlternateContact] `json:"alternateContact"`
	// Name of the company
	CompanyName param.Field[string] `json:"companyName"`
	// optional description of the organization
	Description param.Field[string] `json:"description"`
	// Name of the organization that will be shown to users.
	DisplayName param.Field[string] `json:"displayName"`
	// Identity Provider ID.
	IdpID param.Field[string] `json:"idpId"`
	// Infinity manager setting definition
	InfinityManagerSettings param.Field[SuperAdminOrgControllerOrgUpdateParamsInfinityManagerSettings] `json:"infinityManagerSettings"`
	// Dataset Service enable flag for an organization
	IsDatasetServiceEnabled param.Field[bool] `json:"isDatasetServiceEnabled"`
	// Is NVIDIA internal org or not
	IsInternal param.Field[bool] `json:"isInternal"`
	// Quick Start enable flag for an organization
	IsQuickStartEnabled param.Field[bool] `json:"isQuickStartEnabled"`
	// If a server side encryption is enabled for private registry (models, resources)
	IsRegistrySseEnabled param.Field[bool] `json:"isRegistrySSEEnabled"`
	// Secrets Manager Service enable flag for an organization
	IsSecretsManagerServiceEnabled param.Field[bool] `json:"isSecretsManagerServiceEnabled"`
	// Secure Credential Sharing Service enable flag for an organization
	IsSecureCredentialSharingServiceEnabled param.Field[bool] `json:"isSecureCredentialSharingServiceEnabled"`
	// If a separate influx db used for an organization in Base Command Platform job
	// telemetry
	IsSeparateInfluxDBUsed param.Field[bool] `json:"isSeparateInfluxDbUsed"`
	// Org owner.
	OrgOwner param.Field[SuperAdminOrgControllerOrgUpdateParamsOrgOwner] `json:"orgOwner"`
	// Org owners
	OrgOwners param.Field[[]SuperAdminOrgControllerOrgUpdateParamsOrgOwner] `json:"orgOwners"`
	// product end customer name for enterprise(Fleet Command) product
	PecName param.Field[string] `json:"pecName"`
	// product end customer salesforce.com Id (external customer Id) for
	// enterprise(Fleet Command) product
	PecSfdcID            param.Field[string]                                                      `json:"pecSfdcId"`
	ProductEnablements   param.Field[[]SuperAdminOrgControllerOrgUpdateParamsProductEnablement]   `json:"productEnablements"`
	ProductSubscriptions param.Field[[]SuperAdminOrgControllerOrgUpdateParamsProductSubscription] `json:"productSubscriptions"`
	// Repo scan setting definition
	RepoScanSettings param.Field[SuperAdminOrgControllerOrgUpdateParamsRepoScanSettings] `json:"repoScanSettings"`
	Type             param.Field[SuperAdminOrgControllerOrgUpdateParamsType]             `json:"type"`
}

func (SuperAdminOrgControllerOrgUpdateParams) MarshalJSON 

func (r SuperAdminOrgControllerOrgUpdateParams) MarshalJSON() (data []byte, err error)

type SuperAdminOrgControllerOrgUpdateParamsAlternateContact 

type SuperAdminOrgControllerOrgUpdateParamsAlternateContact struct {
	// Alternate contact's email.
	Email param.Field[string] `json:"email"`
	// Full name of the alternate contact.
	FullName param.Field[string] `json:"fullName"`
}

Org Owner Alternate Contact

func (SuperAdminOrgControllerOrgUpdateParamsAlternateContact) MarshalJSON 

func (r SuperAdminOrgControllerOrgUpdateParamsAlternateContact) MarshalJSON() (data []byte, err error)

type SuperAdminOrgControllerOrgUpdateParamsInfinityManagerSettings 

type SuperAdminOrgControllerOrgUpdateParamsInfinityManagerSettings struct {
	// Enable the infinity manager or not. Used both in org and team level object
	InfinityManagerEnabled param.Field[bool] `json:"infinityManagerEnabled"`
	// Allow override settings at team level. Only used in org level object
	InfinityManagerEnableTeamOverride param.Field[bool] `json:"infinityManagerEnableTeamOverride"`
}

Infinity manager setting definition

func (SuperAdminOrgControllerOrgUpdateParamsInfinityManagerSettings) MarshalJSON 

func (r SuperAdminOrgControllerOrgUpdateParamsInfinityManagerSettings) MarshalJSON() (data []byte, err error)

type SuperAdminOrgControllerOrgUpdateParamsOrgOwner 

type SuperAdminOrgControllerOrgUpdateParamsOrgOwner struct {
	// Email address of the org owner.
	Email param.Field[string] `json:"email,required"`
	// Org owner name.
	FullName param.Field[string] `json:"fullName,required"`
	// Last time the org owner logged in.
	LastLoginDate param.Field[string] `json:"lastLoginDate"`
}

Org owner.

func (SuperAdminOrgControllerOrgUpdateParamsOrgOwner) MarshalJSON 

func (r SuperAdminOrgControllerOrgUpdateParamsOrgOwner) MarshalJSON() (data []byte, err error)

type SuperAdminOrgControllerOrgUpdateParamsProductEnablement 

type SuperAdminOrgControllerOrgUpdateParamsProductEnablement struct {
	// Product Name (NVAIE, BASE_COMMAND, REGISTRY, etc)
	ProductName param.Field[string] `json:"productName,required"`
	// Product Enablement Types
	Type param.Field[SuperAdminOrgControllerOrgUpdateParamsProductEnablementsType] `json:"type,required"`
	// Date on which the subscription expires. The subscription is invalid after this
	// date. (yyyy-MM-dd)
	ExpirationDate param.Field[string]                                                             `json:"expirationDate"`
	PoDetails      param.Field[[]SuperAdminOrgControllerOrgUpdateParamsProductEnablementsPoDetail] `json:"poDetails"`
}

Product Enablement

func (SuperAdminOrgControllerOrgUpdateParamsProductEnablement) MarshalJSON 

func (r SuperAdminOrgControllerOrgUpdateParamsProductEnablement) MarshalJSON() (data []byte, err error)

type SuperAdminOrgControllerOrgUpdateParamsProductEnablementsPoDetail 

type SuperAdminOrgControllerOrgUpdateParamsProductEnablementsPoDetail struct {
	// Entitlement identifier.
	EntitlementID param.Field[string] `json:"entitlementId"`
	// PAK (Product Activation Key) identifier.
	PkID param.Field[string] `json:"pkId"`
}

Purchase Order.

func (SuperAdminOrgControllerOrgUpdateParamsProductEnablementsPoDetail) MarshalJSON 

func (r SuperAdminOrgControllerOrgUpdateParamsProductEnablementsPoDetail) MarshalJSON() (data []byte, err error)

type SuperAdminOrgControllerOrgUpdateParamsProductEnablementsType 

type SuperAdminOrgControllerOrgUpdateParamsProductEnablementsType string

Product Enablement Types 

const (
	SuperAdminOrgControllerOrgUpdateParamsProductEnablementsTypeNgcAdminEval       SuperAdminOrgControllerOrgUpdateParamsProductEnablementsType = "NGC_ADMIN_EVAL"
	SuperAdminOrgControllerOrgUpdateParamsProductEnablementsTypeNgcAdminNfr        SuperAdminOrgControllerOrgUpdateParamsProductEnablementsType = "NGC_ADMIN_NFR"
	SuperAdminOrgControllerOrgUpdateParamsProductEnablementsTypeNgcAdminCommercial SuperAdminOrgControllerOrgUpdateParamsProductEnablementsType = "NGC_ADMIN_COMMERCIAL"
	SuperAdminOrgControllerOrgUpdateParamsProductEnablementsTypeEmsEval            SuperAdminOrgControllerOrgUpdateParamsProductEnablementsType = "EMS_EVAL"
	SuperAdminOrgControllerOrgUpdateParamsProductEnablementsTypeEmsNfr             SuperAdminOrgControllerOrgUpdateParamsProductEnablementsType = "EMS_NFR"
	SuperAdminOrgControllerOrgUpdateParamsProductEnablementsTypeEmsCommercial      SuperAdminOrgControllerOrgUpdateParamsProductEnablementsType = "EMS_COMMERCIAL"
	SuperAdminOrgControllerOrgUpdateParamsProductEnablementsTypeNgcAdminDeveloper  SuperAdminOrgControllerOrgUpdateParamsProductEnablementsType = "NGC_ADMIN_DEVELOPER"
)

func (SuperAdminOrgControllerOrgUpdateParamsProductEnablementsType) IsKnown 

func (r SuperAdminOrgControllerOrgUpdateParamsProductEnablementsType) IsKnown() bool

type SuperAdminOrgControllerOrgUpdateParamsProductSubscription 

type SuperAdminOrgControllerOrgUpdateParamsProductSubscription struct {
	// Product Name (NVAIE, BASE_COMMAND, FleetCommand, REGISTRY, etc).
	ProductName param.Field[string] `json:"productName,required"`
	// Unique entitlement identifier
	ID param.Field[string] `json:"id"`
	// EMS Subscription type. (options: EMS_EVAL, EMS_NFR and EMS_COMMERCIAL)
	EmsEntitlementType param.Field[SuperAdminOrgControllerOrgUpdateParamsProductSubscriptionsEmsEntitlementType] `json:"emsEntitlementType"`
	// Date on which the subscription expires. The subscription is invalid after this
	// date. (yyyy-MM-dd)
	ExpirationDate param.Field[string] `json:"expirationDate"`
	// Date on which the subscription becomes active. (yyyy-MM-dd)
	StartDate param.Field[string] `json:"startDate"`
	// Subscription type. (options: NGC_ADMIN_EVAL, NGC_ADMIN_NFR,
	// NGC_ADMIN_COMMERCIAL)
	Type param.Field[SuperAdminOrgControllerOrgUpdateParamsProductSubscriptionsType] `json:"type"`
}

Product Subscription

func (SuperAdminOrgControllerOrgUpdateParamsProductSubscription) MarshalJSON 

func (r SuperAdminOrgControllerOrgUpdateParamsProductSubscription) MarshalJSON() (data []byte, err error)

type SuperAdminOrgControllerOrgUpdateParamsProductSubscriptionsEmsEntitlementType 

type SuperAdminOrgControllerOrgUpdateParamsProductSubscriptionsEmsEntitlementType string

EMS Subscription type. (options: EMS_EVAL, EMS_NFR and EMS_COMMERCIAL) 

const (
	SuperAdminOrgControllerOrgUpdateParamsProductSubscriptionsEmsEntitlementTypeEmsEval       SuperAdminOrgControllerOrgUpdateParamsProductSubscriptionsEmsEntitlementType = "EMS_EVAL"
	SuperAdminOrgControllerOrgUpdateParamsProductSubscriptionsEmsEntitlementTypeEmsNfr        SuperAdminOrgControllerOrgUpdateParamsProductSubscriptionsEmsEntitlementType = "EMS_NFR"
	SuperAdminOrgControllerOrgUpdateParamsProductSubscriptionsEmsEntitlementTypeEmsCommerical SuperAdminOrgControllerOrgUpdateParamsProductSubscriptionsEmsEntitlementType = "EMS_COMMERICAL"
	SuperAdminOrgControllerOrgUpdateParamsProductSubscriptionsEmsEntitlementTypeEmsCommercial SuperAdminOrgControllerOrgUpdateParamsProductSubscriptionsEmsEntitlementType = "EMS_COMMERCIAL"
)

func (SuperAdminOrgControllerOrgUpdateParamsProductSubscriptionsEmsEntitlementType) IsKnown 

func (r SuperAdminOrgControllerOrgUpdateParamsProductSubscriptionsEmsEntitlementType) IsKnown() bool

type SuperAdminOrgControllerOrgUpdateParamsProductSubscriptionsType 

type SuperAdminOrgControllerOrgUpdateParamsProductSubscriptionsType string

Subscription type. (options: NGC_ADMIN_EVAL, NGC_ADMIN_NFR, NGC_ADMIN_COMMERCIAL) 

const (
	SuperAdminOrgControllerOrgUpdateParamsProductSubscriptionsTypeNgcAdminEval       SuperAdminOrgControllerOrgUpdateParamsProductSubscriptionsType = "NGC_ADMIN_EVAL"
	SuperAdminOrgControllerOrgUpdateParamsProductSubscriptionsTypeNgcAdminNfr        SuperAdminOrgControllerOrgUpdateParamsProductSubscriptionsType = "NGC_ADMIN_NFR"
	SuperAdminOrgControllerOrgUpdateParamsProductSubscriptionsTypeNgcAdminCommercial SuperAdminOrgControllerOrgUpdateParamsProductSubscriptionsType = "NGC_ADMIN_COMMERCIAL"
)

func (SuperAdminOrgControllerOrgUpdateParamsProductSubscriptionsType) IsKnown 

func (r SuperAdminOrgControllerOrgUpdateParamsProductSubscriptionsType) IsKnown() bool

type SuperAdminOrgControllerOrgUpdateParamsRepoScanSettings 

type SuperAdminOrgControllerOrgUpdateParamsRepoScanSettings struct {
	// Allow org admin to override the org level repo scan settings
	RepoScanAllowOverride param.Field[bool] `json:"repoScanAllowOverride"`
	// Allow repository scanning by default
	RepoScanByDefault param.Field[bool] `json:"repoScanByDefault"`
	// Enable the repository scan or not. Only used in org level object
	RepoScanEnabled param.Field[bool] `json:"repoScanEnabled"`
	// Sends notification to end user after scanning is done
	RepoScanEnableNotifications param.Field[bool] `json:"repoScanEnableNotifications"`
	// Allow override settings at team level. Only used in org level object
	RepoScanEnableTeamOverride param.Field[bool] `json:"repoScanEnableTeamOverride"`
	// Allow showing scan results to CLI or UI
	RepoScanShowResults param.Field[bool] `json:"repoScanShowResults"`
}

Repo scan setting definition

func (SuperAdminOrgControllerOrgUpdateParamsRepoScanSettings) MarshalJSON 

func (r SuperAdminOrgControllerOrgUpdateParamsRepoScanSettings) MarshalJSON() (data []byte, err error)

type SuperAdminOrgControllerOrgUpdateParamsType 

type SuperAdminOrgControllerOrgUpdateParamsType string
const (
	SuperAdminOrgControllerOrgUpdateParamsTypeUnknown    SuperAdminOrgControllerOrgUpdateParamsType = "UNKNOWN"
	SuperAdminOrgControllerOrgUpdateParamsTypeCloud      SuperAdminOrgControllerOrgUpdateParamsType = "CLOUD"
	SuperAdminOrgControllerOrgUpdateParamsTypeEnterprise SuperAdminOrgControllerOrgUpdateParamsType = "ENTERPRISE"
	SuperAdminOrgControllerOrgUpdateParamsTypeIndividual SuperAdminOrgControllerOrgUpdateParamsType = "INDIVIDUAL"
)

func (SuperAdminOrgControllerOrgUpdateParamsType) IsKnown 

func (r SuperAdminOrgControllerOrgUpdateParamsType) IsKnown() bool

type SuperAdminOrgControllerService 

type SuperAdminOrgControllerService struct {
	Options []option.RequestOption
	Org     *SuperAdminOrgControllerOrgService
}

SuperAdminOrgControllerService contains methods and other services that help with interacting with the ngc API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewSuperAdminOrgControllerService method instead.

func NewSuperAdminOrgControllerService 

func NewSuperAdminOrgControllerService(opts ...option.RequestOption) (r *SuperAdminOrgControllerService)

NewSuperAdminOrgControllerService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*SuperAdminOrgControllerService) BackfillOrgsToKratos 

func (r *SuperAdminOrgControllerService) BackfillOrgsToKratos(ctx context.Context, opts ...option.RequestOption) (res *http.Response, err error)

Backfill Orgs to Kratos

type SuperAdminOrgNewParams 

type SuperAdminOrgNewParams struct {
	// Org owner.
	OrgOwner param.Field[SuperAdminOrgNewParamsOrgOwner] `json:"orgOwner,required"`
	// user country
	Country param.Field[string] `json:"country"`
	// optional description of the organization
	Description param.Field[string] `json:"description"`
	// Name of the organization that will be shown to users.
	DisplayName param.Field[string] `json:"displayName"`
	// Identity Provider ID.
	IdpID param.Field[string] `json:"idpId"`
	// Is NVIDIA internal org or not
	IsInternal param.Field[bool] `json:"isInternal"`
	// Organization name
	Name param.Field[string] `json:"name"`
	// product end customer name for enterprise(Fleet Command) product
	PecName param.Field[string] `json:"pecName"`
	// product end customer salesforce.com Id (external customer Id) for
	// enterprise(Fleet Command) product
	PecSfdcID          param.Field[string]                                    `json:"pecSfdcId"`
	ProductEnablements param.Field[[]SuperAdminOrgNewParamsProductEnablement] `json:"productEnablements"`
	// This should be deprecated, use productEnablements instead
	ProductSubscriptions param.Field[[]SuperAdminOrgNewParamsProductSubscription] `json:"productSubscriptions"`
	// Company or organization industry
	SalesforceAccountIndustry param.Field[string] `json:"salesforceAccountIndustry"`
	// Send email to org owner or not. Default is true
	SendEmail param.Field[bool]                       `json:"sendEmail"`
	Type      param.Field[SuperAdminOrgNewParamsType] `json:"type"`
	Ncid      param.Field[string]                     `cookie:"ncid"`
	VisitorID param.Field[string]                     `cookie:"VisitorID"`
}

func (SuperAdminOrgNewParams) MarshalJSON 

func (r SuperAdminOrgNewParams) MarshalJSON() (data []byte, err error)

type SuperAdminOrgNewParamsOrgOwner 

type SuperAdminOrgNewParamsOrgOwner struct {
	// Email address of the org owner.
	Email param.Field[string] `json:"email,required"`
	// Org owner name.
	FullName param.Field[string] `json:"fullName,required"`
	// Last time the org owner logged in.
	LastLoginDate param.Field[string] `json:"lastLoginDate"`
}

Org owner.

func (SuperAdminOrgNewParamsOrgOwner) MarshalJSON 

func (r SuperAdminOrgNewParamsOrgOwner) MarshalJSON() (data []byte, err error)

type SuperAdminOrgNewParamsProductEnablement 

type SuperAdminOrgNewParamsProductEnablement struct {
	// Product Name (NVAIE, BASE_COMMAND, REGISTRY, etc)
	ProductName param.Field[string] `json:"productName,required"`
	// Product Enablement Types
	Type param.Field[SuperAdminOrgNewParamsProductEnablementsType] `json:"type,required"`
	// Date on which the subscription expires. The subscription is invalid after this
	// date. (yyyy-MM-dd)
	ExpirationDate param.Field[string]                                             `json:"expirationDate"`
	PoDetails      param.Field[[]SuperAdminOrgNewParamsProductEnablementsPoDetail] `json:"poDetails"`
}

Product Enablement

func (SuperAdminOrgNewParamsProductEnablement) MarshalJSON 

func (r SuperAdminOrgNewParamsProductEnablement) MarshalJSON() (data []byte, err error)

type SuperAdminOrgNewParamsProductEnablementsPoDetail 

type SuperAdminOrgNewParamsProductEnablementsPoDetail struct {
	// Entitlement identifier.
	EntitlementID param.Field[string] `json:"entitlementId"`
	// PAK (Product Activation Key) identifier.
	PkID param.Field[string] `json:"pkId"`
}

Purchase Order.

func (SuperAdminOrgNewParamsProductEnablementsPoDetail) MarshalJSON 

func (r SuperAdminOrgNewParamsProductEnablementsPoDetail) MarshalJSON() (data []byte, err error)

type SuperAdminOrgNewParamsProductEnablementsType 

type SuperAdminOrgNewParamsProductEnablementsType string

Product Enablement Types 

const (
	SuperAdminOrgNewParamsProductEnablementsTypeNgcAdminEval       SuperAdminOrgNewParamsProductEnablementsType = "NGC_ADMIN_EVAL"
	SuperAdminOrgNewParamsProductEnablementsTypeNgcAdminNfr        SuperAdminOrgNewParamsProductEnablementsType = "NGC_ADMIN_NFR"
	SuperAdminOrgNewParamsProductEnablementsTypeNgcAdminCommercial SuperAdminOrgNewParamsProductEnablementsType = "NGC_ADMIN_COMMERCIAL"
	SuperAdminOrgNewParamsProductEnablementsTypeEmsEval            SuperAdminOrgNewParamsProductEnablementsType = "EMS_EVAL"
	SuperAdminOrgNewParamsProductEnablementsTypeEmsNfr             SuperAdminOrgNewParamsProductEnablementsType = "EMS_NFR"
	SuperAdminOrgNewParamsProductEnablementsTypeEmsCommercial      SuperAdminOrgNewParamsProductEnablementsType = "EMS_COMMERCIAL"
	SuperAdminOrgNewParamsProductEnablementsTypeNgcAdminDeveloper  SuperAdminOrgNewParamsProductEnablementsType = "NGC_ADMIN_DEVELOPER"
)

func (SuperAdminOrgNewParamsProductEnablementsType) IsKnown 

func (r SuperAdminOrgNewParamsProductEnablementsType) IsKnown() bool

type SuperAdminOrgNewParamsProductSubscription 

type SuperAdminOrgNewParamsProductSubscription struct {
	// Product Name (NVAIE, BASE_COMMAND, FleetCommand, REGISTRY, etc).
	ProductName param.Field[string] `json:"productName,required"`
	// Unique entitlement identifier
	ID param.Field[string] `json:"id"`
	// EMS Subscription type. (options: EMS_EVAL, EMS_NFR and EMS_COMMERCIAL)
	EmsEntitlementType param.Field[SuperAdminOrgNewParamsProductSubscriptionsEmsEntitlementType] `json:"emsEntitlementType"`
	// Date on which the subscription expires. The subscription is invalid after this
	// date. (yyyy-MM-dd)
	ExpirationDate param.Field[string] `json:"expirationDate"`
	// Date on which the subscription becomes active. (yyyy-MM-dd)
	StartDate param.Field[string] `json:"startDate"`
	// Subscription type. (options: NGC_ADMIN_EVAL, NGC_ADMIN_NFR,
	// NGC_ADMIN_COMMERCIAL)
	Type param.Field[SuperAdminOrgNewParamsProductSubscriptionsType] `json:"type"`
}

Product Subscription

func (SuperAdminOrgNewParamsProductSubscription) MarshalJSON 

func (r SuperAdminOrgNewParamsProductSubscription) MarshalJSON() (data []byte, err error)

type SuperAdminOrgNewParamsProductSubscriptionsEmsEntitlementType 

type SuperAdminOrgNewParamsProductSubscriptionsEmsEntitlementType string

EMS Subscription type. (options: EMS_EVAL, EMS_NFR and EMS_COMMERCIAL) 

const (
	SuperAdminOrgNewParamsProductSubscriptionsEmsEntitlementTypeEmsEval       SuperAdminOrgNewParamsProductSubscriptionsEmsEntitlementType = "EMS_EVAL"
	SuperAdminOrgNewParamsProductSubscriptionsEmsEntitlementTypeEmsNfr        SuperAdminOrgNewParamsProductSubscriptionsEmsEntitlementType = "EMS_NFR"
	SuperAdminOrgNewParamsProductSubscriptionsEmsEntitlementTypeEmsCommerical SuperAdminOrgNewParamsProductSubscriptionsEmsEntitlementType = "EMS_COMMERICAL"
	SuperAdminOrgNewParamsProductSubscriptionsEmsEntitlementTypeEmsCommercial SuperAdminOrgNewParamsProductSubscriptionsEmsEntitlementType = "EMS_COMMERCIAL"
)

func (SuperAdminOrgNewParamsProductSubscriptionsEmsEntitlementType) IsKnown 

func (r SuperAdminOrgNewParamsProductSubscriptionsEmsEntitlementType) IsKnown() bool

type SuperAdminOrgNewParamsProductSubscriptionsType 

type SuperAdminOrgNewParamsProductSubscriptionsType string

Subscription type. (options: NGC_ADMIN_EVAL, NGC_ADMIN_NFR, NGC_ADMIN_COMMERCIAL) 

const (
	SuperAdminOrgNewParamsProductSubscriptionsTypeNgcAdminEval       SuperAdminOrgNewParamsProductSubscriptionsType = "NGC_ADMIN_EVAL"
	SuperAdminOrgNewParamsProductSubscriptionsTypeNgcAdminNfr        SuperAdminOrgNewParamsProductSubscriptionsType = "NGC_ADMIN_NFR"
	SuperAdminOrgNewParamsProductSubscriptionsTypeNgcAdminCommercial SuperAdminOrgNewParamsProductSubscriptionsType = "NGC_ADMIN_COMMERCIAL"
)

func (SuperAdminOrgNewParamsProductSubscriptionsType) IsKnown 

func (r SuperAdminOrgNewParamsProductSubscriptionsType) IsKnown() bool

type SuperAdminOrgNewParamsType 

type SuperAdminOrgNewParamsType string
const (
	SuperAdminOrgNewParamsTypeUnknown    SuperAdminOrgNewParamsType = "UNKNOWN"
	SuperAdminOrgNewParamsTypeCloud      SuperAdminOrgNewParamsType = "CLOUD"
	SuperAdminOrgNewParamsTypeEnterprise SuperAdminOrgNewParamsType = "ENTERPRISE"
	SuperAdminOrgNewParamsTypeIndividual SuperAdminOrgNewParamsType = "INDIVIDUAL"
)

func (SuperAdminOrgNewParamsType) IsKnown 

func (r SuperAdminOrgNewParamsType) IsKnown() bool

type SuperAdminOrgOrgStatusNewParams 

type SuperAdminOrgOrgStatusNewParams struct {
	// False only if called by SbMS.
	CreateSubscription param.Field[bool] `json:"createSubscription,required"`
	// Product Enablement
	ProductEnablement param.Field[SuperAdminOrgOrgStatusNewParamsProductEnablement] `json:"productEnablement,required"`
}

func (SuperAdminOrgOrgStatusNewParams) MarshalJSON 

func (r SuperAdminOrgOrgStatusNewParams) MarshalJSON() (data []byte, err error)

type SuperAdminOrgOrgStatusNewParamsProductEnablement 

type SuperAdminOrgOrgStatusNewParamsProductEnablement struct {
	// Product Name (NVAIE, BASE_COMMAND, REGISTRY, etc)
	ProductName param.Field[string] `json:"productName,required"`
	// Product Enablement Types
	Type param.Field[SuperAdminOrgOrgStatusNewParamsProductEnablementType] `json:"type,required"`
	// Date on which the subscription expires. The subscription is invalid after this
	// date. (yyyy-MM-dd)
	ExpirationDate param.Field[string]                                                     `json:"expirationDate"`
	PoDetails      param.Field[[]SuperAdminOrgOrgStatusNewParamsProductEnablementPoDetail] `json:"poDetails"`
}

Product Enablement

func (SuperAdminOrgOrgStatusNewParamsProductEnablement) MarshalJSON 

func (r SuperAdminOrgOrgStatusNewParamsProductEnablement) MarshalJSON() (data []byte, err error)

type SuperAdminOrgOrgStatusNewParamsProductEnablementPoDetail 

type SuperAdminOrgOrgStatusNewParamsProductEnablementPoDetail struct {
	// Entitlement identifier.
	EntitlementID param.Field[string] `json:"entitlementId"`
	// PAK (Product Activation Key) identifier.
	PkID param.Field[string] `json:"pkId"`
}

Purchase Order.

func (SuperAdminOrgOrgStatusNewParamsProductEnablementPoDetail) MarshalJSON 

func (r SuperAdminOrgOrgStatusNewParamsProductEnablementPoDetail) MarshalJSON() (data []byte, err error)

type SuperAdminOrgOrgStatusNewParamsProductEnablementType 

type SuperAdminOrgOrgStatusNewParamsProductEnablementType string

Product Enablement Types 

const (
	SuperAdminOrgOrgStatusNewParamsProductEnablementTypeNgcAdminEval       SuperAdminOrgOrgStatusNewParamsProductEnablementType = "NGC_ADMIN_EVAL"
	SuperAdminOrgOrgStatusNewParamsProductEnablementTypeNgcAdminNfr        SuperAdminOrgOrgStatusNewParamsProductEnablementType = "NGC_ADMIN_NFR"
	SuperAdminOrgOrgStatusNewParamsProductEnablementTypeNgcAdminCommercial SuperAdminOrgOrgStatusNewParamsProductEnablementType = "NGC_ADMIN_COMMERCIAL"
	SuperAdminOrgOrgStatusNewParamsProductEnablementTypeEmsEval            SuperAdminOrgOrgStatusNewParamsProductEnablementType = "EMS_EVAL"
	SuperAdminOrgOrgStatusNewParamsProductEnablementTypeEmsNfr             SuperAdminOrgOrgStatusNewParamsProductEnablementType = "EMS_NFR"
	SuperAdminOrgOrgStatusNewParamsProductEnablementTypeEmsCommercial      SuperAdminOrgOrgStatusNewParamsProductEnablementType = "EMS_COMMERCIAL"
	SuperAdminOrgOrgStatusNewParamsProductEnablementTypeNgcAdminDeveloper  SuperAdminOrgOrgStatusNewParamsProductEnablementType = "NGC_ADMIN_DEVELOPER"
)

func (SuperAdminOrgOrgStatusNewParamsProductEnablementType) IsKnown 

func (r SuperAdminOrgOrgStatusNewParamsProductEnablementType) IsKnown() bool

type SuperAdminOrgOrgStatusService 

type SuperAdminOrgOrgStatusService struct {
	Options []option.RequestOption
}

SuperAdminOrgOrgStatusService contains methods and other services that help with interacting with the ngc API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewSuperAdminOrgOrgStatusService method instead.

func NewSuperAdminOrgOrgStatusService 

func NewSuperAdminOrgOrgStatusService(opts ...option.RequestOption) (r *SuperAdminOrgOrgStatusService)

NewSuperAdminOrgOrgStatusService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*SuperAdminOrgOrgStatusService) New 

func (r *SuperAdminOrgOrgStatusService) New(ctx context.Context, orgName string, body SuperAdminOrgOrgStatusNewParams, opts ...option.RequestOption) (res *http.Response, err error)

Create org product enablement

type SuperAdminOrgService 

type SuperAdminOrgService struct {
	Options   []option.RequestOption
	OrgStatus *SuperAdminOrgOrgStatusService
}

SuperAdminOrgService contains methods and other services that help with interacting with the ngc API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewSuperAdminOrgService method instead.

func NewSuperAdminOrgService 

func NewSuperAdminOrgService(opts ...option.RequestOption) (r *SuperAdminOrgService)

NewSuperAdminOrgService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*SuperAdminOrgService) New 

func (r *SuperAdminOrgService) New(ctx context.Context, params SuperAdminOrgNewParams, opts ...option.RequestOption) (res *http.Response, err error)

Create a new organization. (SuperAdmin privileges required)

type SuperAdminUserCRMSyncResponse 

type SuperAdminUserCRMSyncResponse struct {
	RequestStatus SuperAdminUserCRMSyncResponseRequestStatus `json:"requestStatus"`
	JSON          superAdminUserCRMSyncResponseJSON          `json:"-"`
}

func (*SuperAdminUserCRMSyncResponse) UnmarshalJSON 

func (r *SuperAdminUserCRMSyncResponse) UnmarshalJSON(data []byte) (err error)

type SuperAdminUserCRMSyncResponseRequestStatus 

type SuperAdminUserCRMSyncResponseRequestStatus struct {
	RequestID string `json:"requestId"`
	ServerID  string `json:"serverId"`
	// Describes response status reported by the server.
	StatusCode        SuperAdminUserCRMSyncResponseRequestStatusStatusCode `json:"statusCode"`
	StatusDescription string                                               `json:"statusDescription"`
	JSON              superAdminUserCRMSyncResponseRequestStatusJSON       `json:"-"`
}

func (*SuperAdminUserCRMSyncResponseRequestStatus) UnmarshalJSON 

func (r *SuperAdminUserCRMSyncResponseRequestStatus) UnmarshalJSON(data []byte) (err error)

type SuperAdminUserCRMSyncResponseRequestStatusStatusCode 

type SuperAdminUserCRMSyncResponseRequestStatusStatusCode string

Describes response status reported by the server. 

const (
	SuperAdminUserCRMSyncResponseRequestStatusStatusCodeUnknown                    SuperAdminUserCRMSyncResponseRequestStatusStatusCode = "UNKNOWN"
	SuperAdminUserCRMSyncResponseRequestStatusStatusCodeSuccess                    SuperAdminUserCRMSyncResponseRequestStatusStatusCode = "SUCCESS"
	SuperAdminUserCRMSyncResponseRequestStatusStatusCodeUnauthorized               SuperAdminUserCRMSyncResponseRequestStatusStatusCode = "UNAUTHORIZED"
	SuperAdminUserCRMSyncResponseRequestStatusStatusCodePaymentRequired            SuperAdminUserCRMSyncResponseRequestStatusStatusCode = "PAYMENT_REQUIRED"
	SuperAdminUserCRMSyncResponseRequestStatusStatusCodeForbidden                  SuperAdminUserCRMSyncResponseRequestStatusStatusCode = "FORBIDDEN"
	SuperAdminUserCRMSyncResponseRequestStatusStatusCodeTimeout                    SuperAdminUserCRMSyncResponseRequestStatusStatusCode = "TIMEOUT"
	SuperAdminUserCRMSyncResponseRequestStatusStatusCodeExists                     SuperAdminUserCRMSyncResponseRequestStatusStatusCode = "EXISTS"
	SuperAdminUserCRMSyncResponseRequestStatusStatusCodeNotFound                   SuperAdminUserCRMSyncResponseRequestStatusStatusCode = "NOT_FOUND"
	SuperAdminUserCRMSyncResponseRequestStatusStatusCodeInternalError              SuperAdminUserCRMSyncResponseRequestStatusStatusCode = "INTERNAL_ERROR"
	SuperAdminUserCRMSyncResponseRequestStatusStatusCodeInvalidRequest             SuperAdminUserCRMSyncResponseRequestStatusStatusCode = "INVALID_REQUEST"
	SuperAdminUserCRMSyncResponseRequestStatusStatusCodeInvalidRequestVersion      SuperAdminUserCRMSyncResponseRequestStatusStatusCode = "INVALID_REQUEST_VERSION"
	SuperAdminUserCRMSyncResponseRequestStatusStatusCodeInvalidRequestData         SuperAdminUserCRMSyncResponseRequestStatusStatusCode = "INVALID_REQUEST_DATA"
	SuperAdminUserCRMSyncResponseRequestStatusStatusCodeMethodNotAllowed           SuperAdminUserCRMSyncResponseRequestStatusStatusCode = "METHOD_NOT_ALLOWED"
	SuperAdminUserCRMSyncResponseRequestStatusStatusCodeConflict                   SuperAdminUserCRMSyncResponseRequestStatusStatusCode = "CONFLICT"
	SuperAdminUserCRMSyncResponseRequestStatusStatusCodeUnprocessableEntity        SuperAdminUserCRMSyncResponseRequestStatusStatusCode = "UNPROCESSABLE_ENTITY"
	SuperAdminUserCRMSyncResponseRequestStatusStatusCodeTooManyRequests            SuperAdminUserCRMSyncResponseRequestStatusStatusCode = "TOO_MANY_REQUESTS"
	SuperAdminUserCRMSyncResponseRequestStatusStatusCodeInsufficientStorage        SuperAdminUserCRMSyncResponseRequestStatusStatusCode = "INSUFFICIENT_STORAGE"
	SuperAdminUserCRMSyncResponseRequestStatusStatusCodeServiceUnavailable         SuperAdminUserCRMSyncResponseRequestStatusStatusCode = "SERVICE_UNAVAILABLE"
	SuperAdminUserCRMSyncResponseRequestStatusStatusCodePayloadTooLarge            SuperAdminUserCRMSyncResponseRequestStatusStatusCode = "PAYLOAD_TOO_LARGE"
	SuperAdminUserCRMSyncResponseRequestStatusStatusCodeNotAcceptable              SuperAdminUserCRMSyncResponseRequestStatusStatusCode = "NOT_ACCEPTABLE"
	SuperAdminUserCRMSyncResponseRequestStatusStatusCodeUnavailableForLegalReasons SuperAdminUserCRMSyncResponseRequestStatusStatusCode = "UNAVAILABLE_FOR_LEGAL_REASONS"
	SuperAdminUserCRMSyncResponseRequestStatusStatusCodeBadGateway                 SuperAdminUserCRMSyncResponseRequestStatusStatusCode = "BAD_GATEWAY"
)

func (SuperAdminUserCRMSyncResponseRequestStatusStatusCode) IsKnown 

func (r SuperAdminUserCRMSyncResponseRequestStatusStatusCode) IsKnown() bool

type SuperAdminUserOrgOrgOwnerBackfillResponse 

type SuperAdminUserOrgOrgOwnerBackfillResponse struct {
	RequestStatus SuperAdminUserOrgOrgOwnerBackfillResponseRequestStatus `json:"requestStatus"`
	JSON          superAdminUserOrgOrgOwnerBackfillResponseJSON          `json:"-"`
}

func (*SuperAdminUserOrgOrgOwnerBackfillResponse) UnmarshalJSON 

func (r *SuperAdminUserOrgOrgOwnerBackfillResponse) UnmarshalJSON(data []byte) (err error)

type SuperAdminUserOrgOrgOwnerBackfillResponseRequestStatus 

type SuperAdminUserOrgOrgOwnerBackfillResponseRequestStatus struct {
	RequestID string `json:"requestId"`
	ServerID  string `json:"serverId"`
	// Describes response status reported by the server.
	StatusCode        SuperAdminUserOrgOrgOwnerBackfillResponseRequestStatusStatusCode `json:"statusCode"`
	StatusDescription string                                                           `json:"statusDescription"`
	JSON              superAdminUserOrgOrgOwnerBackfillResponseRequestStatusJSON       `json:"-"`
}

func (*SuperAdminUserOrgOrgOwnerBackfillResponseRequestStatus) UnmarshalJSON 

func (r *SuperAdminUserOrgOrgOwnerBackfillResponseRequestStatus) UnmarshalJSON(data []byte) (err error)

type SuperAdminUserOrgOrgOwnerBackfillResponseRequestStatusStatusCode 

type SuperAdminUserOrgOrgOwnerBackfillResponseRequestStatusStatusCode string

Describes response status reported by the server. 

const (
	SuperAdminUserOrgOrgOwnerBackfillResponseRequestStatusStatusCodeUnknown                    SuperAdminUserOrgOrgOwnerBackfillResponseRequestStatusStatusCode = "UNKNOWN"
	SuperAdminUserOrgOrgOwnerBackfillResponseRequestStatusStatusCodeSuccess                    SuperAdminUserOrgOrgOwnerBackfillResponseRequestStatusStatusCode = "SUCCESS"
	SuperAdminUserOrgOrgOwnerBackfillResponseRequestStatusStatusCodeUnauthorized               SuperAdminUserOrgOrgOwnerBackfillResponseRequestStatusStatusCode = "UNAUTHORIZED"
	SuperAdminUserOrgOrgOwnerBackfillResponseRequestStatusStatusCodePaymentRequired            SuperAdminUserOrgOrgOwnerBackfillResponseRequestStatusStatusCode = "PAYMENT_REQUIRED"
	SuperAdminUserOrgOrgOwnerBackfillResponseRequestStatusStatusCodeForbidden                  SuperAdminUserOrgOrgOwnerBackfillResponseRequestStatusStatusCode = "FORBIDDEN"
	SuperAdminUserOrgOrgOwnerBackfillResponseRequestStatusStatusCodeTimeout                    SuperAdminUserOrgOrgOwnerBackfillResponseRequestStatusStatusCode = "TIMEOUT"
	SuperAdminUserOrgOrgOwnerBackfillResponseRequestStatusStatusCodeExists                     SuperAdminUserOrgOrgOwnerBackfillResponseRequestStatusStatusCode = "EXISTS"
	SuperAdminUserOrgOrgOwnerBackfillResponseRequestStatusStatusCodeNotFound                   SuperAdminUserOrgOrgOwnerBackfillResponseRequestStatusStatusCode = "NOT_FOUND"
	SuperAdminUserOrgOrgOwnerBackfillResponseRequestStatusStatusCodeInternalError              SuperAdminUserOrgOrgOwnerBackfillResponseRequestStatusStatusCode = "INTERNAL_ERROR"
	SuperAdminUserOrgOrgOwnerBackfillResponseRequestStatusStatusCodeInvalidRequest             SuperAdminUserOrgOrgOwnerBackfillResponseRequestStatusStatusCode = "INVALID_REQUEST"
	SuperAdminUserOrgOrgOwnerBackfillResponseRequestStatusStatusCodeInvalidRequestVersion      SuperAdminUserOrgOrgOwnerBackfillResponseRequestStatusStatusCode = "INVALID_REQUEST_VERSION"
	SuperAdminUserOrgOrgOwnerBackfillResponseRequestStatusStatusCodeInvalidRequestData         SuperAdminUserOrgOrgOwnerBackfillResponseRequestStatusStatusCode = "INVALID_REQUEST_DATA"
	SuperAdminUserOrgOrgOwnerBackfillResponseRequestStatusStatusCodeMethodNotAllowed           SuperAdminUserOrgOrgOwnerBackfillResponseRequestStatusStatusCode = "METHOD_NOT_ALLOWED"
	SuperAdminUserOrgOrgOwnerBackfillResponseRequestStatusStatusCodeConflict                   SuperAdminUserOrgOrgOwnerBackfillResponseRequestStatusStatusCode = "CONFLICT"
	SuperAdminUserOrgOrgOwnerBackfillResponseRequestStatusStatusCodeUnprocessableEntity        SuperAdminUserOrgOrgOwnerBackfillResponseRequestStatusStatusCode = "UNPROCESSABLE_ENTITY"
	SuperAdminUserOrgOrgOwnerBackfillResponseRequestStatusStatusCodeTooManyRequests            SuperAdminUserOrgOrgOwnerBackfillResponseRequestStatusStatusCode = "TOO_MANY_REQUESTS"
	SuperAdminUserOrgOrgOwnerBackfillResponseRequestStatusStatusCodeInsufficientStorage        SuperAdminUserOrgOrgOwnerBackfillResponseRequestStatusStatusCode = "INSUFFICIENT_STORAGE"
	SuperAdminUserOrgOrgOwnerBackfillResponseRequestStatusStatusCodeServiceUnavailable         SuperAdminUserOrgOrgOwnerBackfillResponseRequestStatusStatusCode = "SERVICE_UNAVAILABLE"
	SuperAdminUserOrgOrgOwnerBackfillResponseRequestStatusStatusCodePayloadTooLarge            SuperAdminUserOrgOrgOwnerBackfillResponseRequestStatusStatusCode = "PAYLOAD_TOO_LARGE"
	SuperAdminUserOrgOrgOwnerBackfillResponseRequestStatusStatusCodeNotAcceptable              SuperAdminUserOrgOrgOwnerBackfillResponseRequestStatusStatusCode = "NOT_ACCEPTABLE"
	SuperAdminUserOrgOrgOwnerBackfillResponseRequestStatusStatusCodeUnavailableForLegalReasons SuperAdminUserOrgOrgOwnerBackfillResponseRequestStatusStatusCode = "UNAVAILABLE_FOR_LEGAL_REASONS"
	SuperAdminUserOrgOrgOwnerBackfillResponseRequestStatusStatusCodeBadGateway                 SuperAdminUserOrgOrgOwnerBackfillResponseRequestStatusStatusCode = "BAD_GATEWAY"
)

func (SuperAdminUserOrgOrgOwnerBackfillResponseRequestStatusStatusCode) IsKnown 

func (r SuperAdminUserOrgOrgOwnerBackfillResponseRequestStatusStatusCode) IsKnown() bool

type SuperAdminUserOrgService 

type SuperAdminUserOrgService struct {
	Options []option.RequestOption
	Users   *SuperAdminUserOrgUserService
	Teams   *SuperAdminUserOrgTeamService
}

SuperAdminUserOrgService contains methods and other services that help with interacting with the ngc API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewSuperAdminUserOrgService method instead.

func NewSuperAdminUserOrgService 

func NewSuperAdminUserOrgService(opts ...option.RequestOption) (r *SuperAdminUserOrgService)

NewSuperAdminUserOrgService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*SuperAdminUserOrgService) OrgOwnerBackfill 

func (r *SuperAdminUserOrgService) OrgOwnerBackfill(ctx context.Context, orgName string, opts ...option.RequestOption) (res *SuperAdminUserOrgOrgOwnerBackfillResponse, err error)

Backfill the org owner for users

type SuperAdminUserOrgTeamService 

type SuperAdminUserOrgTeamService struct {
	Options []option.RequestOption
	Users   *SuperAdminUserOrgTeamUserService
}

SuperAdminUserOrgTeamService contains methods and other services that help with interacting with the ngc API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewSuperAdminUserOrgTeamService method instead.

func NewSuperAdminUserOrgTeamService 

func NewSuperAdminUserOrgTeamService(opts ...option.RequestOption) (r *SuperAdminUserOrgTeamService)

NewSuperAdminUserOrgTeamService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

type SuperAdminUserOrgTeamUserAddParams 

type SuperAdminUserOrgTeamUserAddParams struct {
	UserRoleDefaultsToRegistryRead param.Field[string] `query:"user role, defaults to REGISTRY_READ"`
	Ncid                           param.Field[string] `cookie:"ncid"`
	VisitorID                      param.Field[string] `cookie:"VisitorID"`
}

func (SuperAdminUserOrgTeamUserAddParams) URLQuery 

func (r SuperAdminUserOrgTeamUserAddParams) URLQuery() (v url.Values)

URLQuery serializes SuperAdminUserOrgTeamUserAddParams's query parameters as `url.Values`.

type SuperAdminUserOrgTeamUserNewParams 

type SuperAdminUserOrgTeamUserNewParams struct {
	// Email address of the user. This should be unique.
	Email param.Field[string] `json:"email,required"`
	// If the IDP ID is provided then it is used instead of the one configured for the
	// organization
	IdpID param.Field[string] `query:"idp-id"`
	// Boolean to send email notification, default is true
	SendEmail param.Field[bool] `query:"send-email"`
	// indicates if user has opt in to nvidia emails
	EmailOptIn param.Field[bool] `json:"emailOptIn"`
	// indicates if user has accepted EULA
	EulaAccepted param.Field[bool] `json:"eulaAccepted"`
	// user name
	Name param.Field[string] `json:"name"`
	// DEPRECATED - use roleTypes which allows multiple roles
	RoleType param.Field[string] `json:"roleType"`
	// feature roles to give to the user
	RoleTypes param.Field[[]string] `json:"roleTypes"`
	// user job role
	SalesforceContactJobRole param.Field[string] `json:"salesforceContactJobRole"`
	// Metadata information about the user.
	UserMetadata param.Field[SuperAdminUserOrgTeamUserNewParamsUserMetadata] `json:"userMetadata"`
	Ncid         param.Field[string]                                         `cookie:"ncid"`
	VisitorID    param.Field[string]                                         `cookie:"VisitorID"`
}

func (SuperAdminUserOrgTeamUserNewParams) MarshalJSON 

func (r SuperAdminUserOrgTeamUserNewParams) MarshalJSON() (data []byte, err error)

func (SuperAdminUserOrgTeamUserNewParams) URLQuery 

func (r SuperAdminUserOrgTeamUserNewParams) URLQuery() (v url.Values)

URLQuery serializes SuperAdminUserOrgTeamUserNewParams's query parameters as `url.Values`.

type SuperAdminUserOrgTeamUserNewParamsUserMetadata 

type SuperAdminUserOrgTeamUserNewParamsUserMetadata struct {
	// Name of the company
	Company param.Field[string] `json:"company"`
	// Company URL
	CompanyURL param.Field[string] `json:"companyUrl"`
	// Country of the user
	Country param.Field[string] `json:"country"`
	// User's first name
	FirstName param.Field[string] `json:"firstName"`
	// Industry segment
	Industry param.Field[string] `json:"industry"`
	// List of development areas that user has interest
	Interest param.Field[[]string] `json:"interest"`
	// User's last name
	LastName param.Field[string] `json:"lastName"`
	// Role of the user in the company
	Role param.Field[string] `json:"role"`
}

Metadata information about the user.

func (SuperAdminUserOrgTeamUserNewParamsUserMetadata) MarshalJSON 

func (r SuperAdminUserOrgTeamUserNewParamsUserMetadata) MarshalJSON() (data []byte, err error)

type SuperAdminUserOrgTeamUserService 

type SuperAdminUserOrgTeamUserService struct {
	Options []option.RequestOption
}

SuperAdminUserOrgTeamUserService contains methods and other services that help with interacting with the ngc API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewSuperAdminUserOrgTeamUserService method instead.

func NewSuperAdminUserOrgTeamUserService 

func NewSuperAdminUserOrgTeamUserService(opts ...option.RequestOption) (r *SuperAdminUserOrgTeamUserService)

NewSuperAdminUserOrgTeamUserService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*SuperAdminUserOrgTeamUserService) Add 

func (r *SuperAdminUserOrgTeamUserService) Add(ctx context.Context, orgName string, teamName string, id string, params SuperAdminUserOrgTeamUserAddParams, opts ...option.RequestOption) (res *shared.User, err error)

Add existing User to an Team

func (*SuperAdminUserOrgTeamUserService) New 

func (r *SuperAdminUserOrgTeamUserService) New(ctx context.Context, orgName string, teamName string, params SuperAdminUserOrgTeamUserNewParams, opts ...option.RequestOption) (res *shared.User, err error)

Create an Org-Admin User (Super Admin privileges required)

type SuperAdminUserOrgUserAddParams 

type SuperAdminUserOrgUserAddParams struct {
	UserRoleDefaultsToRegistryRead param.Field[string] `query:"user role, defaults to REGISTRY_READ"`
	Ncid                           param.Field[string] `cookie:"ncid"`
	VisitorID                      param.Field[string] `cookie:"VisitorID"`
}

func (SuperAdminUserOrgUserAddParams) URLQuery 

func (r SuperAdminUserOrgUserAddParams) URLQuery() (v url.Values)

URLQuery serializes SuperAdminUserOrgUserAddParams's query parameters as `url.Values`.

type SuperAdminUserOrgUserNewParams 

type SuperAdminUserOrgUserNewParams struct {
	// Email address of the user. This should be unique.
	Email param.Field[string] `json:"email,required"`
	// If the IDP ID is provided then it is used instead of the one configured for the
	// organization
	IdpID param.Field[string] `query:"idp-id"`
	// Boolean to send email notification, default is true
	SendEmail param.Field[bool] `query:"send-email"`
	// indicates if user has opt in to nvidia emails
	EmailOptIn param.Field[bool] `json:"emailOptIn"`
	// indicates if user has accepted EULA
	EulaAccepted param.Field[bool] `json:"eulaAccepted"`
	// user name
	Name param.Field[string] `json:"name"`
	// DEPRECATED - use roleTypes which allows multiple roles
	RoleType param.Field[string] `json:"roleType"`
	// feature roles to give to the user
	RoleTypes param.Field[[]string] `json:"roleTypes"`
	// user job role
	SalesforceContactJobRole param.Field[string] `json:"salesforceContactJobRole"`
	// Metadata information about the user.
	UserMetadata param.Field[SuperAdminUserOrgUserNewParamsUserMetadata] `json:"userMetadata"`
	Ncid         param.Field[string]                                     `cookie:"ncid"`
	VisitorID    param.Field[string]                                     `cookie:"VisitorID"`
}

func (SuperAdminUserOrgUserNewParams) MarshalJSON 

func (r SuperAdminUserOrgUserNewParams) MarshalJSON() (data []byte, err error)

func (SuperAdminUserOrgUserNewParams) URLQuery 

func (r SuperAdminUserOrgUserNewParams) URLQuery() (v url.Values)

URLQuery serializes SuperAdminUserOrgUserNewParams's query parameters as `url.Values`.

type SuperAdminUserOrgUserNewParamsUserMetadata 

type SuperAdminUserOrgUserNewParamsUserMetadata struct {
	// Name of the company
	Company param.Field[string] `json:"company"`
	// Company URL
	CompanyURL param.Field[string] `json:"companyUrl"`
	// Country of the user
	Country param.Field[string] `json:"country"`
	// User's first name
	FirstName param.Field[string] `json:"firstName"`
	// Industry segment
	Industry param.Field[string] `json:"industry"`
	// List of development areas that user has interest
	Interest param.Field[[]string] `json:"interest"`
	// User's last name
	LastName param.Field[string] `json:"lastName"`
	// Role of the user in the company
	Role param.Field[string] `json:"role"`
}

Metadata information about the user.

func (SuperAdminUserOrgUserNewParamsUserMetadata) MarshalJSON 

func (r SuperAdminUserOrgUserNewParamsUserMetadata) MarshalJSON() (data []byte, err error)

type SuperAdminUserOrgUserRemoveResponse 

type SuperAdminUserOrgUserRemoveResponse struct {
	RequestStatus SuperAdminUserOrgUserRemoveResponseRequestStatus `json:"requestStatus"`
	JSON          superAdminUserOrgUserRemoveResponseJSON          `json:"-"`
}

func (*SuperAdminUserOrgUserRemoveResponse) UnmarshalJSON 

func (r *SuperAdminUserOrgUserRemoveResponse) UnmarshalJSON(data []byte) (err error)

type SuperAdminUserOrgUserRemoveResponseRequestStatus 

type SuperAdminUserOrgUserRemoveResponseRequestStatus struct {
	RequestID string `json:"requestId"`
	ServerID  string `json:"serverId"`
	// Describes response status reported by the server.
	StatusCode        SuperAdminUserOrgUserRemoveResponseRequestStatusStatusCode `json:"statusCode"`
	StatusDescription string                                                     `json:"statusDescription"`
	JSON              superAdminUserOrgUserRemoveResponseRequestStatusJSON       `json:"-"`
}

func (*SuperAdminUserOrgUserRemoveResponseRequestStatus) UnmarshalJSON 

func (r *SuperAdminUserOrgUserRemoveResponseRequestStatus) UnmarshalJSON(data []byte) (err error)

type SuperAdminUserOrgUserRemoveResponseRequestStatusStatusCode 

type SuperAdminUserOrgUserRemoveResponseRequestStatusStatusCode string

Describes response status reported by the server. 

const (
	SuperAdminUserOrgUserRemoveResponseRequestStatusStatusCodeUnknown                    SuperAdminUserOrgUserRemoveResponseRequestStatusStatusCode = "UNKNOWN"
	SuperAdminUserOrgUserRemoveResponseRequestStatusStatusCodeSuccess                    SuperAdminUserOrgUserRemoveResponseRequestStatusStatusCode = "SUCCESS"
	SuperAdminUserOrgUserRemoveResponseRequestStatusStatusCodeUnauthorized               SuperAdminUserOrgUserRemoveResponseRequestStatusStatusCode = "UNAUTHORIZED"
	SuperAdminUserOrgUserRemoveResponseRequestStatusStatusCodePaymentRequired            SuperAdminUserOrgUserRemoveResponseRequestStatusStatusCode = "PAYMENT_REQUIRED"
	SuperAdminUserOrgUserRemoveResponseRequestStatusStatusCodeForbidden                  SuperAdminUserOrgUserRemoveResponseRequestStatusStatusCode = "FORBIDDEN"
	SuperAdminUserOrgUserRemoveResponseRequestStatusStatusCodeTimeout                    SuperAdminUserOrgUserRemoveResponseRequestStatusStatusCode = "TIMEOUT"
	SuperAdminUserOrgUserRemoveResponseRequestStatusStatusCodeExists                     SuperAdminUserOrgUserRemoveResponseRequestStatusStatusCode = "EXISTS"
	SuperAdminUserOrgUserRemoveResponseRequestStatusStatusCodeNotFound                   SuperAdminUserOrgUserRemoveResponseRequestStatusStatusCode = "NOT_FOUND"
	SuperAdminUserOrgUserRemoveResponseRequestStatusStatusCodeInternalError              SuperAdminUserOrgUserRemoveResponseRequestStatusStatusCode = "INTERNAL_ERROR"
	SuperAdminUserOrgUserRemoveResponseRequestStatusStatusCodeInvalidRequest             SuperAdminUserOrgUserRemoveResponseRequestStatusStatusCode = "INVALID_REQUEST"
	SuperAdminUserOrgUserRemoveResponseRequestStatusStatusCodeInvalidRequestVersion      SuperAdminUserOrgUserRemoveResponseRequestStatusStatusCode = "INVALID_REQUEST_VERSION"
	SuperAdminUserOrgUserRemoveResponseRequestStatusStatusCodeInvalidRequestData         SuperAdminUserOrgUserRemoveResponseRequestStatusStatusCode = "INVALID_REQUEST_DATA"
	SuperAdminUserOrgUserRemoveResponseRequestStatusStatusCodeMethodNotAllowed           SuperAdminUserOrgUserRemoveResponseRequestStatusStatusCode = "METHOD_NOT_ALLOWED"
	SuperAdminUserOrgUserRemoveResponseRequestStatusStatusCodeConflict                   SuperAdminUserOrgUserRemoveResponseRequestStatusStatusCode = "CONFLICT"
	SuperAdminUserOrgUserRemoveResponseRequestStatusStatusCodeUnprocessableEntity        SuperAdminUserOrgUserRemoveResponseRequestStatusStatusCode = "UNPROCESSABLE_ENTITY"
	SuperAdminUserOrgUserRemoveResponseRequestStatusStatusCodeTooManyRequests            SuperAdminUserOrgUserRemoveResponseRequestStatusStatusCode = "TOO_MANY_REQUESTS"
	SuperAdminUserOrgUserRemoveResponseRequestStatusStatusCodeInsufficientStorage        SuperAdminUserOrgUserRemoveResponseRequestStatusStatusCode = "INSUFFICIENT_STORAGE"
	SuperAdminUserOrgUserRemoveResponseRequestStatusStatusCodeServiceUnavailable         SuperAdminUserOrgUserRemoveResponseRequestStatusStatusCode = "SERVICE_UNAVAILABLE"
	SuperAdminUserOrgUserRemoveResponseRequestStatusStatusCodePayloadTooLarge            SuperAdminUserOrgUserRemoveResponseRequestStatusStatusCode = "PAYLOAD_TOO_LARGE"
	SuperAdminUserOrgUserRemoveResponseRequestStatusStatusCodeNotAcceptable              SuperAdminUserOrgUserRemoveResponseRequestStatusStatusCode = "NOT_ACCEPTABLE"
	SuperAdminUserOrgUserRemoveResponseRequestStatusStatusCodeUnavailableForLegalReasons SuperAdminUserOrgUserRemoveResponseRequestStatusStatusCode = "UNAVAILABLE_FOR_LEGAL_REASONS"
	SuperAdminUserOrgUserRemoveResponseRequestStatusStatusCodeBadGateway                 SuperAdminUserOrgUserRemoveResponseRequestStatusStatusCode = "BAD_GATEWAY"
)

func (SuperAdminUserOrgUserRemoveResponseRequestStatusStatusCode) IsKnown 

func (r SuperAdminUserOrgUserRemoveResponseRequestStatusStatusCode) IsKnown() bool

type SuperAdminUserOrgUserService 

type SuperAdminUserOrgUserService struct {
	Options []option.RequestOption
}

SuperAdminUserOrgUserService contains methods and other services that help with interacting with the ngc API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewSuperAdminUserOrgUserService method instead.

func NewSuperAdminUserOrgUserService 

func NewSuperAdminUserOrgUserService(opts ...option.RequestOption) (r *SuperAdminUserOrgUserService)

NewSuperAdminUserOrgUserService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*SuperAdminUserOrgUserService) Add 

func (r *SuperAdminUserOrgUserService) Add(ctx context.Context, orgName string, id string, params SuperAdminUserOrgUserAddParams, opts ...option.RequestOption) (res *shared.User, err error)

Add existing User to an Org

func (*SuperAdminUserOrgUserService) New 

func (r *SuperAdminUserOrgUserService) New(ctx context.Context, orgName string, params SuperAdminUserOrgUserNewParams, opts ...option.RequestOption) (res *shared.User, err error)

Create an user in an Organization (Super Admin privileges required)

func (*SuperAdminUserOrgUserService) Remove 

func (r *SuperAdminUserOrgUserService) Remove(ctx context.Context, orgName string, id string, opts ...option.RequestOption) (res *SuperAdminUserOrgUserRemoveResponse, err error)

Remove User from org.

type SuperAdminUserService 

type SuperAdminUserService struct {
	Options []option.RequestOption
	Orgs    *SuperAdminUserOrgService
}

SuperAdminUserService contains methods and other services that help with interacting with the ngc API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewSuperAdminUserService method instead.

func NewSuperAdminUserService 

func NewSuperAdminUserService(opts ...option.RequestOption) (r *SuperAdminUserService)

NewSuperAdminUserService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*SuperAdminUserService) CRMSync 

func (r *SuperAdminUserService) CRMSync(ctx context.Context, id int64, opts ...option.RequestOption) (res *SuperAdminUserCRMSyncResponse, err error)

Sync crm id with user email (Super Admin privileges required)

func (*SuperAdminUserService) MigrateDeprecatedRoles 

func (r *SuperAdminUserService) MigrateDeprecatedRoles(ctx context.Context, id string, opts ...option.RequestOption) (res *shared.User, err error)

Migrate User Deprecated Roles.

type SwaggerResourceConfigurationSecurityService 

type SwaggerResourceConfigurationSecurityService struct {
	Options []option.RequestOption
}

SwaggerResourceConfigurationSecurityService contains methods and other services that help with interacting with the ngc API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewSwaggerResourceConfigurationSecurityService method instead.

func NewSwaggerResourceConfigurationSecurityService 

func NewSwaggerResourceConfigurationSecurityService(opts ...option.RequestOption) (r *SwaggerResourceConfigurationSecurityService)

NewSwaggerResourceConfigurationSecurityService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*SwaggerResourceConfigurationSecurityService) Delete 

func (r *SwaggerResourceConfigurationSecurityService) Delete(ctx context.Context, opts ...option.RequestOption) (res *http.Response, err error)

func (*SwaggerResourceConfigurationSecurityService) Get 

func (r *SwaggerResourceConfigurationSecurityService) Get(ctx context.Context, opts ...option.RequestOption) (res *http.Response, err error)

func (*SwaggerResourceConfigurationSecurityService) New 

func (r *SwaggerResourceConfigurationSecurityService) New(ctx context.Context, opts ...option.RequestOption) (res *http.Response, err error)

func (*SwaggerResourceConfigurationSecurityService) Update 

func (r *SwaggerResourceConfigurationSecurityService) Update(ctx context.Context, opts ...option.RequestOption) (res *http.Response, err error)

type SwaggerResourceConfigurationService 

type SwaggerResourceConfigurationService struct {
	Options  []option.RequestOption
	Ui       *SwaggerResourceConfigurationUiService
	Security *SwaggerResourceConfigurationSecurityService
}

SwaggerResourceConfigurationService contains methods and other services that help with interacting with the ngc API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewSwaggerResourceConfigurationService method instead.

func NewSwaggerResourceConfigurationService 

func NewSwaggerResourceConfigurationService(opts ...option.RequestOption) (r *SwaggerResourceConfigurationService)

NewSwaggerResourceConfigurationService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

type SwaggerResourceConfigurationUiService 

type SwaggerResourceConfigurationUiService struct {
	Options []option.RequestOption
}

SwaggerResourceConfigurationUiService contains methods and other services that help with interacting with the ngc API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewSwaggerResourceConfigurationUiService method instead.

func NewSwaggerResourceConfigurationUiService 

func NewSwaggerResourceConfigurationUiService(opts ...option.RequestOption) (r *SwaggerResourceConfigurationUiService)

NewSwaggerResourceConfigurationUiService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*SwaggerResourceConfigurationUiService) Delete 

func (r *SwaggerResourceConfigurationUiService) Delete(ctx context.Context, opts ...option.RequestOption) (res *http.Response, err error)

func (*SwaggerResourceConfigurationUiService) Get 

func (r *SwaggerResourceConfigurationUiService) Get(ctx context.Context, opts ...option.RequestOption) (res *http.Response, err error)

func (*SwaggerResourceConfigurationUiService) New 

func (r *SwaggerResourceConfigurationUiService) New(ctx context.Context, opts ...option.RequestOption) (res *http.Response, err error)

func (*SwaggerResourceConfigurationUiService) Update 

func (r *SwaggerResourceConfigurationUiService) Update(ctx context.Context, opts ...option.RequestOption) (res *http.Response, err error)

type SwaggerResourceService 

type SwaggerResourceService struct {
	Options       []option.RequestOption
	Configuration *SwaggerResourceConfigurationService
}

SwaggerResourceService contains methods and other services that help with interacting with the ngc API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewSwaggerResourceService method instead.

func NewSwaggerResourceService 

func NewSwaggerResourceService(opts ...option.RequestOption) (r *SwaggerResourceService)

NewSwaggerResourceService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*SwaggerResourceService) Delete 

func (r *SwaggerResourceService) Delete(ctx context.Context, opts ...option.RequestOption) (res *http.Response, err error)

func (*SwaggerResourceService) GetAll 

func (r *SwaggerResourceService) GetAll(ctx context.Context, opts ...option.RequestOption) (res *http.Response, err error)

func (*SwaggerResourceService) New 

func (r *SwaggerResourceService) New(ctx context.Context, opts ...option.RequestOption) (res *http.Response, err error)

func (*SwaggerResourceService) Update 

func (r *SwaggerResourceService) Update(ctx context.Context, opts ...option.RequestOption) (res *http.Response, err error)

type TeamCreateResponse 

type TeamCreateResponse struct {
	RequestStatus TeamCreateResponseRequestStatus `json:"requestStatus"`
	// Information about the team
	Team TeamCreateResponseTeam `json:"team"`
	JSON teamCreateResponseJSON `json:"-"`
}

response to an team creation request, includes unique team id

func (*TeamCreateResponse) UnmarshalJSON 

func (r *TeamCreateResponse) UnmarshalJSON(data []byte) (err error)

type TeamCreateResponseRequestStatus 

type TeamCreateResponseRequestStatus struct {
	RequestID string `json:"requestId"`
	ServerID  string `json:"serverId"`
	// Describes response status reported by the server.
	StatusCode        TeamCreateResponseRequestStatusStatusCode `json:"statusCode"`
	StatusDescription string                                    `json:"statusDescription"`
	JSON              teamCreateResponseRequestStatusJSON       `json:"-"`
}

func (*TeamCreateResponseRequestStatus) UnmarshalJSON 

func (r *TeamCreateResponseRequestStatus) UnmarshalJSON(data []byte) (err error)

type TeamCreateResponseRequestStatusStatusCode 

type TeamCreateResponseRequestStatusStatusCode string

Describes response status reported by the server. 

const (
	TeamCreateResponseRequestStatusStatusCodeUnknown                    TeamCreateResponseRequestStatusStatusCode = "UNKNOWN"
	TeamCreateResponseRequestStatusStatusCodeSuccess                    TeamCreateResponseRequestStatusStatusCode = "SUCCESS"
	TeamCreateResponseRequestStatusStatusCodeUnauthorized               TeamCreateResponseRequestStatusStatusCode = "UNAUTHORIZED"
	TeamCreateResponseRequestStatusStatusCodePaymentRequired            TeamCreateResponseRequestStatusStatusCode = "PAYMENT_REQUIRED"
	TeamCreateResponseRequestStatusStatusCodeForbidden                  TeamCreateResponseRequestStatusStatusCode = "FORBIDDEN"
	TeamCreateResponseRequestStatusStatusCodeTimeout                    TeamCreateResponseRequestStatusStatusCode = "TIMEOUT"
	TeamCreateResponseRequestStatusStatusCodeExists                     TeamCreateResponseRequestStatusStatusCode = "EXISTS"
	TeamCreateResponseRequestStatusStatusCodeNotFound                   TeamCreateResponseRequestStatusStatusCode = "NOT_FOUND"
	TeamCreateResponseRequestStatusStatusCodeInternalError              TeamCreateResponseRequestStatusStatusCode = "INTERNAL_ERROR"
	TeamCreateResponseRequestStatusStatusCodeInvalidRequest             TeamCreateResponseRequestStatusStatusCode = "INVALID_REQUEST"
	TeamCreateResponseRequestStatusStatusCodeInvalidRequestVersion      TeamCreateResponseRequestStatusStatusCode = "INVALID_REQUEST_VERSION"
	TeamCreateResponseRequestStatusStatusCodeInvalidRequestData         TeamCreateResponseRequestStatusStatusCode = "INVALID_REQUEST_DATA"
	TeamCreateResponseRequestStatusStatusCodeMethodNotAllowed           TeamCreateResponseRequestStatusStatusCode = "METHOD_NOT_ALLOWED"
	TeamCreateResponseRequestStatusStatusCodeConflict                   TeamCreateResponseRequestStatusStatusCode = "CONFLICT"
	TeamCreateResponseRequestStatusStatusCodeUnprocessableEntity        TeamCreateResponseRequestStatusStatusCode = "UNPROCESSABLE_ENTITY"
	TeamCreateResponseRequestStatusStatusCodeTooManyRequests            TeamCreateResponseRequestStatusStatusCode = "TOO_MANY_REQUESTS"
	TeamCreateResponseRequestStatusStatusCodeInsufficientStorage        TeamCreateResponseRequestStatusStatusCode = "INSUFFICIENT_STORAGE"
	TeamCreateResponseRequestStatusStatusCodeServiceUnavailable         TeamCreateResponseRequestStatusStatusCode = "SERVICE_UNAVAILABLE"
	TeamCreateResponseRequestStatusStatusCodePayloadTooLarge            TeamCreateResponseRequestStatusStatusCode = "PAYLOAD_TOO_LARGE"
	TeamCreateResponseRequestStatusStatusCodeNotAcceptable              TeamCreateResponseRequestStatusStatusCode = "NOT_ACCEPTABLE"
	TeamCreateResponseRequestStatusStatusCodeUnavailableForLegalReasons TeamCreateResponseRequestStatusStatusCode = "UNAVAILABLE_FOR_LEGAL_REASONS"
	TeamCreateResponseRequestStatusStatusCodeBadGateway                 TeamCreateResponseRequestStatusStatusCode = "BAD_GATEWAY"
)

func (TeamCreateResponseRequestStatusStatusCode) IsKnown 

func (r TeamCreateResponseRequestStatusStatusCode) IsKnown() bool

type TeamCreateResponseTeam 

type TeamCreateResponseTeam struct {
	// unique Id of this team.
	ID int64 `json:"id"`
	// description of the team
	Description string `json:"description"`
	// Infinity manager setting definition
	InfinityManagerSettings TeamCreateResponseTeamInfinityManagerSettings `json:"infinityManagerSettings"`
	// indicates if the team is deleted or not
	IsDeleted bool `json:"isDeleted"`
	// team name
	Name string `json:"name"`
	// Repo scan setting definition
	RepoScanSettings TeamCreateResponseTeamRepoScanSettings `json:"repoScanSettings"`
	JSON             teamCreateResponseTeamJSON             `json:"-"`
}

Information about the team

func (*TeamCreateResponseTeam) UnmarshalJSON 

func (r *TeamCreateResponseTeam) UnmarshalJSON(data []byte) (err error)

type TeamCreateResponseTeamInfinityManagerSettings 

type TeamCreateResponseTeamInfinityManagerSettings struct {
	// Enable the infinity manager or not. Used both in org and team level object
	InfinityManagerEnabled bool `json:"infinityManagerEnabled"`
	// Allow override settings at team level. Only used in org level object
	InfinityManagerEnableTeamOverride bool                                              `json:"infinityManagerEnableTeamOverride"`
	JSON                              teamCreateResponseTeamInfinityManagerSettingsJSON `json:"-"`
}

Infinity manager setting definition

func (*TeamCreateResponseTeamInfinityManagerSettings) UnmarshalJSON 

func (r *TeamCreateResponseTeamInfinityManagerSettings) UnmarshalJSON(data []byte) (err error)

type TeamCreateResponseTeamRepoScanSettings 

type TeamCreateResponseTeamRepoScanSettings struct {
	// Allow org admin to override the org level repo scan settings
	RepoScanAllowOverride bool `json:"repoScanAllowOverride"`
	// Allow repository scanning by default
	RepoScanByDefault bool `json:"repoScanByDefault"`
	// Enable the repository scan or not. Only used in org level object
	RepoScanEnabled bool `json:"repoScanEnabled"`
	// Sends notification to end user after scanning is done
	RepoScanEnableNotifications bool `json:"repoScanEnableNotifications"`
	// Allow override settings at team level. Only used in org level object
	RepoScanEnableTeamOverride bool `json:"repoScanEnableTeamOverride"`
	// Allow showing scan results to CLI or UI
	RepoScanShowResults bool                                       `json:"repoScanShowResults"`
	JSON                teamCreateResponseTeamRepoScanSettingsJSON `json:"-"`
}

Repo scan setting definition

func (*TeamCreateResponseTeamRepoScanSettings) UnmarshalJSON 

func (r *TeamCreateResponseTeamRepoScanSettings) UnmarshalJSON(data []byte) (err error)

type TeamList 

type TeamList = shared.TeamList

listing of all teams

This is an alias to an internal type.

type TeamListPaginationInfo 

type TeamListPaginationInfo = shared.TeamListPaginationInfo

object that describes the pagination information

This is an alias to an internal type.

type TeamListRequestStatus 

type TeamListRequestStatus = shared.TeamListRequestStatus

This is an alias to an internal type.

type TeamListRequestStatusStatusCode 

type TeamListRequestStatusStatusCode = shared.TeamListRequestStatusStatusCode

Describes response status reported by the server.

This is an alias to an internal type.

type TeamListTeam 

type TeamListTeam = shared.TeamListTeam

Information about the team

This is an alias to an internal type.

type TeamListTeamsInfinityManagerSettings 

type TeamListTeamsInfinityManagerSettings = shared.TeamListTeamsInfinityManagerSettings

Infinity manager setting definition

This is an alias to an internal type.

type TeamListTeamsRepoScanSettings 

type TeamListTeamsRepoScanSettings = shared.TeamListTeamsRepoScanSettings

Repo scan setting definition

This is an alias to an internal type.

type TeamResponse 

type TeamResponse struct {
	RequestStatus TeamResponseRequestStatus `json:"requestStatus"`
	// Information about the team
	Team TeamResponseTeam `json:"team"`
	JSON teamResponseJSON `json:"-"`
}

details about one team

func (*TeamResponse) UnmarshalJSON 

func (r *TeamResponse) UnmarshalJSON(data []byte) (err error)

type TeamResponseRequestStatus 

type TeamResponseRequestStatus struct {
	RequestID string `json:"requestId"`
	ServerID  string `json:"serverId"`
	// Describes response status reported by the server.
	StatusCode        TeamResponseRequestStatusStatusCode `json:"statusCode"`
	StatusDescription string                              `json:"statusDescription"`
	JSON              teamResponseRequestStatusJSON       `json:"-"`
}

func (*TeamResponseRequestStatus) UnmarshalJSON 

func (r *TeamResponseRequestStatus) UnmarshalJSON(data []byte) (err error)

type TeamResponseRequestStatusStatusCode 

type TeamResponseRequestStatusStatusCode string

Describes response status reported by the server. 

const (
	TeamResponseRequestStatusStatusCodeUnknown                    TeamResponseRequestStatusStatusCode = "UNKNOWN"
	TeamResponseRequestStatusStatusCodeSuccess                    TeamResponseRequestStatusStatusCode = "SUCCESS"
	TeamResponseRequestStatusStatusCodeUnauthorized               TeamResponseRequestStatusStatusCode = "UNAUTHORIZED"
	TeamResponseRequestStatusStatusCodePaymentRequired            TeamResponseRequestStatusStatusCode = "PAYMENT_REQUIRED"
	TeamResponseRequestStatusStatusCodeForbidden                  TeamResponseRequestStatusStatusCode = "FORBIDDEN"
	TeamResponseRequestStatusStatusCodeTimeout                    TeamResponseRequestStatusStatusCode = "TIMEOUT"
	TeamResponseRequestStatusStatusCodeExists                     TeamResponseRequestStatusStatusCode = "EXISTS"
	TeamResponseRequestStatusStatusCodeNotFound                   TeamResponseRequestStatusStatusCode = "NOT_FOUND"
	TeamResponseRequestStatusStatusCodeInternalError              TeamResponseRequestStatusStatusCode = "INTERNAL_ERROR"
	TeamResponseRequestStatusStatusCodeInvalidRequest             TeamResponseRequestStatusStatusCode = "INVALID_REQUEST"
	TeamResponseRequestStatusStatusCodeInvalidRequestVersion      TeamResponseRequestStatusStatusCode = "INVALID_REQUEST_VERSION"
	TeamResponseRequestStatusStatusCodeInvalidRequestData         TeamResponseRequestStatusStatusCode = "INVALID_REQUEST_DATA"
	TeamResponseRequestStatusStatusCodeMethodNotAllowed           TeamResponseRequestStatusStatusCode = "METHOD_NOT_ALLOWED"
	TeamResponseRequestStatusStatusCodeConflict                   TeamResponseRequestStatusStatusCode = "CONFLICT"
	TeamResponseRequestStatusStatusCodeUnprocessableEntity        TeamResponseRequestStatusStatusCode = "UNPROCESSABLE_ENTITY"
	TeamResponseRequestStatusStatusCodeTooManyRequests            TeamResponseRequestStatusStatusCode = "TOO_MANY_REQUESTS"
	TeamResponseRequestStatusStatusCodeInsufficientStorage        TeamResponseRequestStatusStatusCode = "INSUFFICIENT_STORAGE"
	TeamResponseRequestStatusStatusCodeServiceUnavailable         TeamResponseRequestStatusStatusCode = "SERVICE_UNAVAILABLE"
	TeamResponseRequestStatusStatusCodePayloadTooLarge            TeamResponseRequestStatusStatusCode = "PAYLOAD_TOO_LARGE"
	TeamResponseRequestStatusStatusCodeNotAcceptable              TeamResponseRequestStatusStatusCode = "NOT_ACCEPTABLE"
	TeamResponseRequestStatusStatusCodeUnavailableForLegalReasons TeamResponseRequestStatusStatusCode = "UNAVAILABLE_FOR_LEGAL_REASONS"
	TeamResponseRequestStatusStatusCodeBadGateway                 TeamResponseRequestStatusStatusCode = "BAD_GATEWAY"
)

func (TeamResponseRequestStatusStatusCode) IsKnown 

func (r TeamResponseRequestStatusStatusCode) IsKnown() bool

type TeamResponseTeam 

type TeamResponseTeam struct {
	// unique Id of this team.
	ID int64 `json:"id"`
	// description of the team
	Description string `json:"description"`
	// Infinity manager setting definition
	InfinityManagerSettings TeamResponseTeamInfinityManagerSettings `json:"infinityManagerSettings"`
	// indicates if the team is deleted or not
	IsDeleted bool `json:"isDeleted"`
	// team name
	Name string `json:"name"`
	// Repo scan setting definition
	RepoScanSettings TeamResponseTeamRepoScanSettings `json:"repoScanSettings"`
	JSON             teamResponseTeamJSON             `json:"-"`
}

Information about the team

func (*TeamResponseTeam) UnmarshalJSON 

func (r *TeamResponseTeam) UnmarshalJSON(data []byte) (err error)

type TeamResponseTeamInfinityManagerSettings 

type TeamResponseTeamInfinityManagerSettings struct {
	// Enable the infinity manager or not. Used both in org and team level object
	InfinityManagerEnabled bool `json:"infinityManagerEnabled"`
	// Allow override settings at team level. Only used in org level object
	InfinityManagerEnableTeamOverride bool                                        `json:"infinityManagerEnableTeamOverride"`
	JSON                              teamResponseTeamInfinityManagerSettingsJSON `json:"-"`
}

Infinity manager setting definition

func (*TeamResponseTeamInfinityManagerSettings) UnmarshalJSON 

func (r *TeamResponseTeamInfinityManagerSettings) UnmarshalJSON(data []byte) (err error)

type TeamResponseTeamRepoScanSettings 

type TeamResponseTeamRepoScanSettings struct {
	// Allow org admin to override the org level repo scan settings
	RepoScanAllowOverride bool `json:"repoScanAllowOverride"`
	// Allow repository scanning by default
	RepoScanByDefault bool `json:"repoScanByDefault"`
	// Enable the repository scan or not. Only used in org level object
	RepoScanEnabled bool `json:"repoScanEnabled"`
	// Sends notification to end user after scanning is done
	RepoScanEnableNotifications bool `json:"repoScanEnableNotifications"`
	// Allow override settings at team level. Only used in org level object
	RepoScanEnableTeamOverride bool `json:"repoScanEnableTeamOverride"`
	// Allow showing scan results to CLI or UI
	RepoScanShowResults bool                                 `json:"repoScanShowResults"`
	JSON                teamResponseTeamRepoScanSettingsJSON `json:"-"`
}

Repo scan setting definition

func (*TeamResponseTeamRepoScanSettings) UnmarshalJSON 

func (r *TeamResponseTeamRepoScanSettings) UnmarshalJSON(data []byte) (err error)

type User 

type User = shared.User

about one user

This is an alias to an internal type.

type UserInvitationList 

type UserInvitationList = shared.UserInvitationList

Response for a list of user invitations.

This is an alias to an internal type.

type UserInvitationListInvitation 

type UserInvitationListInvitation = shared.UserInvitationListInvitation

User invitation to an NGC org or team

This is an alias to an internal type.

type UserInvitationListInvitationsType 

type UserInvitationListInvitationsType = shared.UserInvitationListInvitationsType

Type of invitation. The invitation is either to an organization or to a team within organization.

This is an alias to an internal type.

type UserInvitationListPaginationInfo 

type UserInvitationListPaginationInfo = shared.UserInvitationListPaginationInfo

object that describes the pagination information

This is an alias to an internal type.

type UserInvitationListRequestStatus 

type UserInvitationListRequestStatus = shared.UserInvitationListRequestStatus

This is an alias to an internal type.

type UserInvitationListRequestStatusStatusCode 

type UserInvitationListRequestStatusStatusCode = shared.UserInvitationListRequestStatusStatusCode

Describes response status reported by the server.

This is an alias to an internal type.

type UserKeyResponse 

type UserKeyResponse struct {
	Key              string                       `json:"key,required"`
	CloudNfsKey      string                       `json:"cloudNfsKey"`
	CloudNfsKeyPwd   string                       `json:"cloudNfsKeyPwd"`
	CloudNfsUserName string                       `json:"cloudNfsUserName"`
	RequestStatus    UserKeyResponseRequestStatus `json:"requestStatus"`
	JSON             userKeyResponseJSON          `json:"-"`
}

response to a request to access key such as docker token

func (*UserKeyResponse) UnmarshalJSON 

func (r *UserKeyResponse) UnmarshalJSON(data []byte) (err error)

type UserKeyResponseRequestStatus 

type UserKeyResponseRequestStatus struct {
	RequestID string `json:"requestId"`
	ServerID  string `json:"serverId"`
	// Describes response status reported by the server.
	StatusCode        UserKeyResponseRequestStatusStatusCode `json:"statusCode"`
	StatusDescription string                                 `json:"statusDescription"`
	JSON              userKeyResponseRequestStatusJSON       `json:"-"`
}

func (*UserKeyResponseRequestStatus) UnmarshalJSON 

func (r *UserKeyResponseRequestStatus) UnmarshalJSON(data []byte) (err error)

type UserKeyResponseRequestStatusStatusCode 

type UserKeyResponseRequestStatusStatusCode string

Describes response status reported by the server. 

const (
	UserKeyResponseRequestStatusStatusCodeUnknown                    UserKeyResponseRequestStatusStatusCode = "UNKNOWN"
	UserKeyResponseRequestStatusStatusCodeSuccess                    UserKeyResponseRequestStatusStatusCode = "SUCCESS"
	UserKeyResponseRequestStatusStatusCodeUnauthorized               UserKeyResponseRequestStatusStatusCode = "UNAUTHORIZED"
	UserKeyResponseRequestStatusStatusCodePaymentRequired            UserKeyResponseRequestStatusStatusCode = "PAYMENT_REQUIRED"
	UserKeyResponseRequestStatusStatusCodeForbidden                  UserKeyResponseRequestStatusStatusCode = "FORBIDDEN"
	UserKeyResponseRequestStatusStatusCodeTimeout                    UserKeyResponseRequestStatusStatusCode = "TIMEOUT"
	UserKeyResponseRequestStatusStatusCodeExists                     UserKeyResponseRequestStatusStatusCode = "EXISTS"
	UserKeyResponseRequestStatusStatusCodeNotFound                   UserKeyResponseRequestStatusStatusCode = "NOT_FOUND"
	UserKeyResponseRequestStatusStatusCodeInternalError              UserKeyResponseRequestStatusStatusCode = "INTERNAL_ERROR"
	UserKeyResponseRequestStatusStatusCodeInvalidRequest             UserKeyResponseRequestStatusStatusCode = "INVALID_REQUEST"
	UserKeyResponseRequestStatusStatusCodeInvalidRequestVersion      UserKeyResponseRequestStatusStatusCode = "INVALID_REQUEST_VERSION"
	UserKeyResponseRequestStatusStatusCodeInvalidRequestData         UserKeyResponseRequestStatusStatusCode = "INVALID_REQUEST_DATA"
	UserKeyResponseRequestStatusStatusCodeMethodNotAllowed           UserKeyResponseRequestStatusStatusCode = "METHOD_NOT_ALLOWED"
	UserKeyResponseRequestStatusStatusCodeConflict                   UserKeyResponseRequestStatusStatusCode = "CONFLICT"
	UserKeyResponseRequestStatusStatusCodeUnprocessableEntity        UserKeyResponseRequestStatusStatusCode = "UNPROCESSABLE_ENTITY"
	UserKeyResponseRequestStatusStatusCodeTooManyRequests            UserKeyResponseRequestStatusStatusCode = "TOO_MANY_REQUESTS"
	UserKeyResponseRequestStatusStatusCodeInsufficientStorage        UserKeyResponseRequestStatusStatusCode = "INSUFFICIENT_STORAGE"
	UserKeyResponseRequestStatusStatusCodeServiceUnavailable         UserKeyResponseRequestStatusStatusCode = "SERVICE_UNAVAILABLE"
	UserKeyResponseRequestStatusStatusCodePayloadTooLarge            UserKeyResponseRequestStatusStatusCode = "PAYLOAD_TOO_LARGE"
	UserKeyResponseRequestStatusStatusCodeNotAcceptable              UserKeyResponseRequestStatusStatusCode = "NOT_ACCEPTABLE"
	UserKeyResponseRequestStatusStatusCodeUnavailableForLegalReasons UserKeyResponseRequestStatusStatusCode = "UNAVAILABLE_FOR_LEGAL_REASONS"
	UserKeyResponseRequestStatusStatusCodeBadGateway                 UserKeyResponseRequestStatusStatusCode = "BAD_GATEWAY"
)

func (UserKeyResponseRequestStatusStatusCode) IsKnown 

func (r UserKeyResponseRequestStatusStatusCode) IsKnown() bool

type UserList 

type UserList = shared.UserList

Response for List User reponse

This is an alias to an internal type.

type UserListPaginationInfo 

type UserListPaginationInfo = shared.UserListPaginationInfo

object that describes the pagination information

This is an alias to an internal type.

type UserListRequestStatus 

type UserListRequestStatus = shared.UserListRequestStatus

This is an alias to an internal type.

type UserListRequestStatusStatusCode 

type UserListRequestStatusStatusCode = shared.UserListRequestStatusStatusCode

Describes response status reported by the server.

This is an alias to an internal type.

type UserListUser 

type UserListUser = shared.UserListUser

information about the user

This is an alias to an internal type.

type UserListUsersIdpType 

type UserListUsersIdpType = shared.UserListUsersIdpType

Type of IDP, Identity Provider. Used for login.

This is an alias to an internal type.

type UserListUsersRole 

type UserListUsersRole = shared.UserListUsersRole

List of roles that the user have

This is an alias to an internal type.

type UserListUsersRolesOrg 

type UserListUsersRolesOrg = shared.UserListUsersRolesOrg

Information about the Organization

This is an alias to an internal type.

type UserListUsersRolesOrgAlternateContact 

type UserListUsersRolesOrgAlternateContact = shared.UserListUsersRolesOrgAlternateContact

Org Owner Alternate Contact

This is an alias to an internal type.

type UserListUsersRolesOrgInfinityManagerSettings 

type UserListUsersRolesOrgInfinityManagerSettings = shared.UserListUsersRolesOrgInfinityManagerSettings

Infinity manager setting definition

This is an alias to an internal type.

type UserListUsersRolesOrgOrgOwner 

type UserListUsersRolesOrgOrgOwner = shared.UserListUsersRolesOrgOrgOwner

Org owner.

This is an alias to an internal type.

type UserListUsersRolesOrgProductEnablement 

type UserListUsersRolesOrgProductEnablement = shared.UserListUsersRolesOrgProductEnablement

Product Enablement

This is an alias to an internal type.

type UserListUsersRolesOrgProductEnablementsPoDetail 

type UserListUsersRolesOrgProductEnablementsPoDetail = shared.UserListUsersRolesOrgProductEnablementsPoDetail

Purchase Order.

This is an alias to an internal type.

type UserListUsersRolesOrgProductEnablementsType 

type UserListUsersRolesOrgProductEnablementsType = shared.UserListUsersRolesOrgProductEnablementsType

Product Enablement Types

This is an alias to an internal type.

type UserListUsersRolesOrgProductSubscription 

type UserListUsersRolesOrgProductSubscription = shared.UserListUsersRolesOrgProductSubscription

Product Subscription

This is an alias to an internal type.

type UserListUsersRolesOrgProductSubscriptionsEmsEntitlementType 

type UserListUsersRolesOrgProductSubscriptionsEmsEntitlementType = shared.UserListUsersRolesOrgProductSubscriptionsEmsEntitlementType

EMS Subscription type. (options: EMS_EVAL, EMS_NFR and EMS_COMMERCIAL)

This is an alias to an internal type.

type UserListUsersRolesOrgProductSubscriptionsType 

type UserListUsersRolesOrgProductSubscriptionsType = shared.UserListUsersRolesOrgProductSubscriptionsType

Subscription type. (options: NGC_ADMIN_EVAL, NGC_ADMIN_NFR, NGC_ADMIN_COMMERCIAL)

This is an alias to an internal type.

type UserListUsersRolesOrgRepoScanSettings 

type UserListUsersRolesOrgRepoScanSettings = shared.UserListUsersRolesOrgRepoScanSettings

Repo scan setting definition

This is an alias to an internal type.

type UserListUsersRolesOrgType 

type UserListUsersRolesOrgType = shared.UserListUsersRolesOrgType

This is an alias to an internal type.

type UserListUsersRolesOrgUsersInfo 

type UserListUsersRolesOrgUsersInfo = shared.UserListUsersRolesOrgUsersInfo

Users information.

This is an alias to an internal type.

type UserListUsersRolesTargetSystemUserIdentifier 

type UserListUsersRolesTargetSystemUserIdentifier = shared.UserListUsersRolesTargetSystemUserIdentifier

Information about the user who is attempting to run the job

This is an alias to an internal type.

type UserListUsersRolesTeam 

type UserListUsersRolesTeam = shared.UserListUsersRolesTeam

Information about the team

This is an alias to an internal type.

type UserListUsersRolesTeamInfinityManagerSettings 

type UserListUsersRolesTeamInfinityManagerSettings = shared.UserListUsersRolesTeamInfinityManagerSettings

Infinity manager setting definition

This is an alias to an internal type.

type UserListUsersRolesTeamRepoScanSettings 

type UserListUsersRolesTeamRepoScanSettings = shared.UserListUsersRolesTeamRepoScanSettings

Repo scan setting definition

This is an alias to an internal type.

type UserListUsersStorageQuota 

type UserListUsersStorageQuota = shared.UserListUsersStorageQuota

represents user storage quota for a given ace and available unused storage

This is an alias to an internal type.

type UserListUsersUserMetadata 

type UserListUsersUserMetadata = shared.UserListUsersUserMetadata

Metadata information about the user.

This is an alias to an internal type.

type UserNcaRole 

type UserNcaRole = shared.UserNcaRole

NCA role

This is an alias to an internal type.

type UserRequestStatus 

type UserRequestStatus = shared.UserRequestStatus

This is an alias to an internal type.

type UserRequestStatusStatusCode 

type UserRequestStatusStatusCode = shared.UserRequestStatusStatusCode

Describes response status reported by the server.

This is an alias to an internal type.

type UserRoleDefinitions 

type UserRoleDefinitions struct {
	RequestStatus UserRoleDefinitionsRequestStatus `json:"requestStatus"`
	// List of roles
	Roles []UserRoleDefinitionsRole `json:"roles"`
	JSON  userRoleDefinitionsJSON   `json:"-"`
}

Response containing all the roles defined in NGC and their allowed actions

func (*UserRoleDefinitions) UnmarshalJSON 

func (r *UserRoleDefinitions) UnmarshalJSON(data []byte) (err error)

type UserRoleDefinitionsRequestStatus 

type UserRoleDefinitionsRequestStatus struct {
	RequestID string `json:"requestId"`
	ServerID  string `json:"serverId"`
	// Describes response status reported by the server.
	StatusCode        UserRoleDefinitionsRequestStatusStatusCode `json:"statusCode"`
	StatusDescription string                                     `json:"statusDescription"`
	JSON              userRoleDefinitionsRequestStatusJSON       `json:"-"`
}

func (*UserRoleDefinitionsRequestStatus) UnmarshalJSON 

func (r *UserRoleDefinitionsRequestStatus) UnmarshalJSON(data []byte) (err error)

type UserRoleDefinitionsRequestStatusStatusCode 

type UserRoleDefinitionsRequestStatusStatusCode string

Describes response status reported by the server. 

const (
	UserRoleDefinitionsRequestStatusStatusCodeUnknown                    UserRoleDefinitionsRequestStatusStatusCode = "UNKNOWN"
	UserRoleDefinitionsRequestStatusStatusCodeSuccess                    UserRoleDefinitionsRequestStatusStatusCode = "SUCCESS"
	UserRoleDefinitionsRequestStatusStatusCodeUnauthorized               UserRoleDefinitionsRequestStatusStatusCode = "UNAUTHORIZED"
	UserRoleDefinitionsRequestStatusStatusCodePaymentRequired            UserRoleDefinitionsRequestStatusStatusCode = "PAYMENT_REQUIRED"
	UserRoleDefinitionsRequestStatusStatusCodeForbidden                  UserRoleDefinitionsRequestStatusStatusCode = "FORBIDDEN"
	UserRoleDefinitionsRequestStatusStatusCodeTimeout                    UserRoleDefinitionsRequestStatusStatusCode = "TIMEOUT"
	UserRoleDefinitionsRequestStatusStatusCodeExists                     UserRoleDefinitionsRequestStatusStatusCode = "EXISTS"
	UserRoleDefinitionsRequestStatusStatusCodeNotFound                   UserRoleDefinitionsRequestStatusStatusCode = "NOT_FOUND"
	UserRoleDefinitionsRequestStatusStatusCodeInternalError              UserRoleDefinitionsRequestStatusStatusCode = "INTERNAL_ERROR"
	UserRoleDefinitionsRequestStatusStatusCodeInvalidRequest             UserRoleDefinitionsRequestStatusStatusCode = "INVALID_REQUEST"
	UserRoleDefinitionsRequestStatusStatusCodeInvalidRequestVersion      UserRoleDefinitionsRequestStatusStatusCode = "INVALID_REQUEST_VERSION"
	UserRoleDefinitionsRequestStatusStatusCodeInvalidRequestData         UserRoleDefinitionsRequestStatusStatusCode = "INVALID_REQUEST_DATA"
	UserRoleDefinitionsRequestStatusStatusCodeMethodNotAllowed           UserRoleDefinitionsRequestStatusStatusCode = "METHOD_NOT_ALLOWED"
	UserRoleDefinitionsRequestStatusStatusCodeConflict                   UserRoleDefinitionsRequestStatusStatusCode = "CONFLICT"
	UserRoleDefinitionsRequestStatusStatusCodeUnprocessableEntity        UserRoleDefinitionsRequestStatusStatusCode = "UNPROCESSABLE_ENTITY"
	UserRoleDefinitionsRequestStatusStatusCodeTooManyRequests            UserRoleDefinitionsRequestStatusStatusCode = "TOO_MANY_REQUESTS"
	UserRoleDefinitionsRequestStatusStatusCodeInsufficientStorage        UserRoleDefinitionsRequestStatusStatusCode = "INSUFFICIENT_STORAGE"
	UserRoleDefinitionsRequestStatusStatusCodeServiceUnavailable         UserRoleDefinitionsRequestStatusStatusCode = "SERVICE_UNAVAILABLE"
	UserRoleDefinitionsRequestStatusStatusCodePayloadTooLarge            UserRoleDefinitionsRequestStatusStatusCode = "PAYLOAD_TOO_LARGE"
	UserRoleDefinitionsRequestStatusStatusCodeNotAcceptable              UserRoleDefinitionsRequestStatusStatusCode = "NOT_ACCEPTABLE"
	UserRoleDefinitionsRequestStatusStatusCodeUnavailableForLegalReasons UserRoleDefinitionsRequestStatusStatusCode = "UNAVAILABLE_FOR_LEGAL_REASONS"
	UserRoleDefinitionsRequestStatusStatusCodeBadGateway                 UserRoleDefinitionsRequestStatusStatusCode = "BAD_GATEWAY"
)

func (UserRoleDefinitionsRequestStatusStatusCode) IsKnown 

func (r UserRoleDefinitionsRequestStatusStatusCode) IsKnown() bool

type UserRoleDefinitionsRole 

type UserRoleDefinitionsRole struct {
	// List of actions that this role allows
	AllowedActions []UserRoleDefinitionsRolesAllowedAction `json:"allowedActions"`
	// Display Name of the role
	DisplayName string `json:"displayName"`
	// Name of the role
	Name string `json:"name"`
	// Product information of the role
	Product UserRoleDefinitionsRolesProduct `json:"product"`
	// Short Display Name of the role
	ShortDisplayName string                      `json:"shortDisplayName"`
	JSON             userRoleDefinitionsRoleJSON `json:"-"`
}

List of roles

func (*UserRoleDefinitionsRole) UnmarshalJSON 

func (r *UserRoleDefinitionsRole) UnmarshalJSON(data []byte) (err error)

type UserRoleDefinitionsRolesAllowedAction 

type UserRoleDefinitionsRolesAllowedAction struct {
	// List of access levels that this role allows
	AccessLevels []string `json:"accessLevels"`
	// Service that this role allows
	Service string                                    `json:"service"`
	JSON    userRoleDefinitionsRolesAllowedActionJSON `json:"-"`
}

List of actions that this role allows

func (*UserRoleDefinitionsRolesAllowedAction) UnmarshalJSON 

func (r *UserRoleDefinitionsRolesAllowedAction) UnmarshalJSON(data []byte) (err error)

type UserRoleDefinitionsRolesProduct 

type UserRoleDefinitionsRolesProduct struct {
	// Display Name of the product from the product catalog to which this role is
	// associated with
	DisplayName string `json:"displayName"`
	// Name of the product from the product catalog to which this role is associated
	// with
	Name string                              `json:"name"`
	JSON userRoleDefinitionsRolesProductJSON `json:"-"`
}

Product information of the role

func (*UserRoleDefinitionsRolesProduct) UnmarshalJSON 

func (r *UserRoleDefinitionsRolesProduct) UnmarshalJSON(data []byte) (err error)

type UserService 

type UserService struct {
	Options []option.RequestOption
	V2      *UserV2Service
}

UserService contains methods and other services that help with interacting with the ngc API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewUserService method instead.

func NewUserService 

func NewUserService(opts ...option.RequestOption) (r *UserService)

NewUserService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

type UserUser 

type UserUser = shared.UserUser

information about the user

This is an alias to an internal type.

type UserUserIdpType 

type UserUserIdpType = shared.UserUserIdpType

Type of IDP, Identity Provider. Used for login.

This is an alias to an internal type.

type UserUserRole 

type UserUserRole = shared.UserUserRole

List of roles that the user have

This is an alias to an internal type.

type UserUserRolesOrg 

type UserUserRolesOrg = shared.UserUserRolesOrg

Information about the Organization

This is an alias to an internal type.

type UserUserRolesOrgAlternateContact 

type UserUserRolesOrgAlternateContact = shared.UserUserRolesOrgAlternateContact

Org Owner Alternate Contact

This is an alias to an internal type.

type UserUserRolesOrgInfinityManagerSettings 

type UserUserRolesOrgInfinityManagerSettings = shared.UserUserRolesOrgInfinityManagerSettings

Infinity manager setting definition

This is an alias to an internal type.

type UserUserRolesOrgOrgOwner 

type UserUserRolesOrgOrgOwner = shared.UserUserRolesOrgOrgOwner

Org owner.

This is an alias to an internal type.

type UserUserRolesOrgProductEnablement 

type UserUserRolesOrgProductEnablement = shared.UserUserRolesOrgProductEnablement

Product Enablement

This is an alias to an internal type.

type UserUserRolesOrgProductEnablementsPoDetail 

type UserUserRolesOrgProductEnablementsPoDetail = shared.UserUserRolesOrgProductEnablementsPoDetail

Purchase Order.

This is an alias to an internal type.

type UserUserRolesOrgProductEnablementsType 

type UserUserRolesOrgProductEnablementsType = shared.UserUserRolesOrgProductEnablementsType

Product Enablement Types

This is an alias to an internal type.

type UserUserRolesOrgProductSubscription 

type UserUserRolesOrgProductSubscription = shared.UserUserRolesOrgProductSubscription

Product Subscription

This is an alias to an internal type.

type UserUserRolesOrgProductSubscriptionsEmsEntitlementType 

type UserUserRolesOrgProductSubscriptionsEmsEntitlementType = shared.UserUserRolesOrgProductSubscriptionsEmsEntitlementType

EMS Subscription type. (options: EMS_EVAL, EMS_NFR and EMS_COMMERCIAL)

This is an alias to an internal type.

type UserUserRolesOrgProductSubscriptionsType 

type UserUserRolesOrgProductSubscriptionsType = shared.UserUserRolesOrgProductSubscriptionsType

Subscription type. (options: NGC_ADMIN_EVAL, NGC_ADMIN_NFR, NGC_ADMIN_COMMERCIAL)

This is an alias to an internal type.

type UserUserRolesOrgRepoScanSettings 

type UserUserRolesOrgRepoScanSettings = shared.UserUserRolesOrgRepoScanSettings

Repo scan setting definition

This is an alias to an internal type.

type UserUserRolesOrgType 

type UserUserRolesOrgType = shared.UserUserRolesOrgType

This is an alias to an internal type.

type UserUserRolesOrgUsersInfo 

type UserUserRolesOrgUsersInfo = shared.UserUserRolesOrgUsersInfo

Users information.

This is an alias to an internal type.

type UserUserRolesTargetSystemUserIdentifier 

type UserUserRolesTargetSystemUserIdentifier = shared.UserUserRolesTargetSystemUserIdentifier

Information about the user who is attempting to run the job

This is an alias to an internal type.

type UserUserRolesTeam 

type UserUserRolesTeam = shared.UserUserRolesTeam

Information about the team

This is an alias to an internal type.

type UserUserRolesTeamInfinityManagerSettings 

type UserUserRolesTeamInfinityManagerSettings = shared.UserUserRolesTeamInfinityManagerSettings

Infinity manager setting definition

This is an alias to an internal type.

type UserUserRolesTeamRepoScanSettings 

type UserUserRolesTeamRepoScanSettings = shared.UserUserRolesTeamRepoScanSettings

Repo scan setting definition

This is an alias to an internal type.

type UserUserStorageQuota 

type UserUserStorageQuota = shared.UserUserStorageQuota

represents user storage quota for a given ace and available unused storage

This is an alias to an internal type.

type UserUserUserMetadata 

type UserUserUserMetadata = shared.UserUserUserMetadata

Metadata information about the user.

This is an alias to an internal type.

type UserV2APIKeyService 

type UserV2APIKeyService struct {
	Options []option.RequestOption
}

UserV2APIKeyService contains methods and other services that help with interacting with the ngc API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewUserV2APIKeyService method instead.

func NewUserV2APIKeyService 

func NewUserV2APIKeyService(opts ...option.RequestOption) (r *UserV2APIKeyService)

NewUserV2APIKeyService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*UserV2APIKeyService) New 

func (r *UserV2APIKeyService) New(ctx context.Context, opts ...option.RequestOption) (res *UserKeyResponse, err error)

Generate API Key

type UserV2Service 

type UserV2Service struct {
	Options []option.RequestOption
	APIKey  *UserV2APIKeyService
}

UserV2Service contains methods and other services that help with interacting with the ngc API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewUserV2Service method instead.

func NewUserV2Service 

func NewUserV2Service(opts ...option.RequestOption) (r *UserV2Service)

NewUserV2Service generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

type UsersManagementMeGetParams 

type UsersManagementMeGetParams struct {
	OrgName param.Field[string] `query:"org-name"`
}

func (UsersManagementMeGetParams) URLQuery 

func (r UsersManagementMeGetParams) URLQuery() (v url.Values)

URLQuery serializes UsersManagementMeGetParams's query parameters as `url.Values`.

type UsersManagementMeService 

type UsersManagementMeService struct {
	Options []option.RequestOption
}

UsersManagementMeService contains methods and other services that help with interacting with the ngc API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewUsersManagementMeService method instead.

func NewUsersManagementMeService 

func NewUsersManagementMeService(opts ...option.RequestOption) (r *UsersManagementMeService)

NewUsersManagementMeService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*UsersManagementMeService) Get 

func (r *UsersManagementMeService) Get(ctx context.Context, query UsersManagementMeGetParams, opts ...option.RequestOption) (res *shared.User, err error)

What am I?

func (*UsersManagementMeService) Update 

func (r *UsersManagementMeService) Update(ctx context.Context, body UsersManagementMeUpdateParams, opts ...option.RequestOption) (res *shared.User, err error)

Edit current user profile

type UsersManagementMeUpdateParams 

type UsersManagementMeUpdateParams struct {
	// indicates if user has opt in to nvidia emails
	HasEmailOptIn param.Field[bool] `json:"hasEmailOptIn"`
	// indicates if user has accepted AI Foundry Partnerships End User License
	// Agreement.
	HasSignedAIFoundryPartnershipsEula param.Field[bool] `json:"hasSignedAiFoundryPartnershipsEULA"`
	// indicates if user has accepted Base Command EULA
	HasSignedBaseCommandEula param.Field[bool] `json:"hasSignedBaseCommandEULA"`
	// indicates if user has accepted Base Command Manager End User License Agreement.
	HasSignedBaseCommandManagerEula param.Field[bool] `json:"hasSignedBaseCommandManagerEULA"`
	// indicates if user has accepted BioNeMo End User License Agreement.
	HasSignedBioNeMoEula param.Field[bool] `json:"hasSignedBioNeMoEULA"`
	// indicates if user has accepted container publishing eula
	HasSignedContainerPublishingEula param.Field[bool] `json:"hasSignedContainerPublishingEULA"`
	// indicates if user has accepted CuOpt End User License Agreement.
	HasSignedCuOptEula param.Field[bool] `json:"hasSignedCuOptEULA"`
	// indicates if user has accepted Earth-2 End User License Agreement.
	HasSignedEarth2Eula param.Field[bool] `json:"hasSignedEarth2EULA"`
	// indicates if user has accepted EGX EULA
	HasSignedEgxEula param.Field[bool] `json:"hasSignedEgxEULA"`
	// indicates if user has accepted NGC EULA
	HasSignedEula param.Field[bool] `json:"hasSignedEULA"`
	// indicates if user has accepted Fleet Command End User License Agreement.
	HasSignedFleetCommandEula param.Field[bool] `json:"hasSignedFleetCommandEULA"`
	// indicates if user has accepted LLM End User License Agreement.
	HasSignedLlmEula param.Field[bool] `json:"hasSignedLlmEULA"`
	// indicates if user has accepted Fleet Command End User License Agreement.
	HasSignedNvaieeula param.Field[bool] `json:"hasSignedNVAIEEULA"`
	// indicates if user has accepted NVIDIA EULA
	HasSignedNvidiaEula param.Field[bool] `json:"hasSignedNvidiaEULA"`
	// indicates if user has accepted Nvidia Quantum Cloud End User License Agreement.
	HasSignedNvqceula param.Field[bool] `json:"hasSignedNVQCEULA"`
	// indicates if user has accepted Omniverse End User License Agreement.
	HasSignedOmniverseEula param.Field[bool] `json:"hasSignedOmniverseEULA"`
	// indicates if the user has signed the Privacy Policy
	HasSignedPrivacyPolicy param.Field[bool] `json:"hasSignedPrivacyPolicy"`
	// indicates if user has consented to share their registration info with other
	// parties
	HasSignedThirdPartyRegistryShareEula param.Field[bool] `json:"hasSignedThirdPartyRegistryShareEULA"`
	// user name
	Name param.Field[string] `json:"name"`
	// Metadata information about the user.
	UserMetadata param.Field[UsersManagementMeUpdateParamsUserMetadata] `json:"userMetadata"`
}

func (UsersManagementMeUpdateParams) MarshalJSON 

func (r UsersManagementMeUpdateParams) MarshalJSON() (data []byte, err error)

type UsersManagementMeUpdateParamsUserMetadata 

type UsersManagementMeUpdateParamsUserMetadata struct {
	// Name of the company
	Company param.Field[string] `json:"company"`
	// Company URL
	CompanyURL param.Field[string] `json:"companyUrl"`
	// Country of the user
	Country param.Field[string] `json:"country"`
	// User's first name
	FirstName param.Field[string] `json:"firstName"`
	// Industry segment
	Industry param.Field[string] `json:"industry"`
	// List of development areas that user has interest
	Interest param.Field[[]string] `json:"interest"`
	// User's last name
	LastName param.Field[string] `json:"lastName"`
	// Role of the user in the company
	Role param.Field[string] `json:"role"`
}

Metadata information about the user.

func (UsersManagementMeUpdateParamsUserMetadata) MarshalJSON 

func (r UsersManagementMeUpdateParamsUserMetadata) MarshalJSON() (data []byte, err error)

type UsersManagementService 

type UsersManagementService struct {
	Options []option.RequestOption
	Me      *UsersManagementMeService
}

UsersManagementService contains methods and other services that help with interacting with the ngc API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewUsersManagementService method instead.

func NewUsersManagementService 

func NewUsersManagementService(opts ...option.RequestOption) (r *UsersManagementService)

NewUsersManagementService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

type V2AdminEntitlementGetAllParams 

type V2AdminEntitlementGetAllParams struct {
	// get is paid subscription entitlements
	IsPaidSubscription param.Field[bool] `query:"is-paid-subscription"`
	// filter by product-name
	ProductName param.Field[string] `query:"product-name"`
}

func (V2AdminEntitlementGetAllParams) URLQuery 

func (r V2AdminEntitlementGetAllParams) URLQuery() (v url.Values)

URLQuery serializes V2AdminEntitlementGetAllParams's query parameters as `url.Values`.

type V2AdminEntitlementService 

type V2AdminEntitlementService struct {
	Options []option.RequestOption
}

V2AdminEntitlementService contains methods and other services that help with interacting with the ngc API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewV2AdminEntitlementService method instead.

func NewV2AdminEntitlementService 

func NewV2AdminEntitlementService(opts ...option.RequestOption) (r *V2AdminEntitlementService)

NewV2AdminEntitlementService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*V2AdminEntitlementService) GetAll 

func (r *V2AdminEntitlementService) GetAll(ctx context.Context, query V2AdminEntitlementGetAllParams, opts ...option.RequestOption) (res *http.Response, err error)

List all organizations with entitlements. (SuperAdmin, ECM and Billing privileges required)

type V2AdminOrgEntitlementGetAllParams 

type V2AdminOrgEntitlementGetAllParams struct {
	// get is paid subscription entitlements
	IsPaidSubscription param.Field[bool] `query:"is-paid-subscription"`
	// filter by product-name
	ProductName param.Field[string] `query:"product-name"`
}

func (V2AdminOrgEntitlementGetAllParams) URLQuery 

func (r V2AdminOrgEntitlementGetAllParams) URLQuery() (v url.Values)

URLQuery serializes V2AdminOrgEntitlementGetAllParams's query parameters as `url.Values`.

type V2AdminOrgEntitlementService 

type V2AdminOrgEntitlementService struct {
	Options []option.RequestOption
}

V2AdminOrgEntitlementService contains methods and other services that help with interacting with the ngc API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewV2AdminOrgEntitlementService method instead.

func NewV2AdminOrgEntitlementService 

func NewV2AdminOrgEntitlementService(opts ...option.RequestOption) (r *V2AdminOrgEntitlementService)

NewV2AdminOrgEntitlementService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*V2AdminOrgEntitlementService) GetAll 

func (r *V2AdminOrgEntitlementService) GetAll(ctx context.Context, orgName string, query V2AdminOrgEntitlementGetAllParams, opts ...option.RequestOption) (res *http.Response, err error)

List all organizations with entitlements. (SuperAdmin, ECM and Billing privileges required)

type V2AdminOrgTeamService 

type V2AdminOrgTeamService struct {
	Options []option.RequestOption
}

V2AdminOrgTeamService contains methods and other services that help with interacting with the ngc API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewV2AdminOrgTeamService method instead.

func NewV2AdminOrgTeamService 

func NewV2AdminOrgTeamService(opts ...option.RequestOption) (r *V2AdminOrgTeamService)

NewV2AdminOrgTeamService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*V2AdminOrgTeamService) Get 

func (r *V2AdminOrgTeamService) Get(ctx context.Context, orgName string, teamName string, opts ...option.RequestOption) (res *http.Response, err error)

Get one team

func (*V2AdminOrgTeamService) Update 

func (r *V2AdminOrgTeamService) Update(ctx context.Context, orgName string, teamName string, body V2AdminOrgTeamUpdateParams, opts ...option.RequestOption) (res *http.Response, err error)

Edit a Team

type V2AdminOrgTeamUpdateParams 

type V2AdminOrgTeamUpdateParams struct {
	// description of the team
	Description param.Field[string] `json:"description"`
	// Infinity manager setting definition
	InfinityManagerSettings param.Field[V2AdminOrgTeamUpdateParamsInfinityManagerSettings] `json:"infinityManagerSettings"`
	// Repo scan setting definition
	RepoScanSettings param.Field[V2AdminOrgTeamUpdateParamsRepoScanSettings] `json:"repoScanSettings"`
}

func (V2AdminOrgTeamUpdateParams) MarshalJSON 

func (r V2AdminOrgTeamUpdateParams) MarshalJSON() (data []byte, err error)

type V2AdminOrgTeamUpdateParamsInfinityManagerSettings 

type V2AdminOrgTeamUpdateParamsInfinityManagerSettings struct {
	// Enable the infinity manager or not. Used both in org and team level object
	InfinityManagerEnabled param.Field[bool] `json:"infinityManagerEnabled"`
	// Allow override settings at team level. Only used in org level object
	InfinityManagerEnableTeamOverride param.Field[bool] `json:"infinityManagerEnableTeamOverride"`
}

Infinity manager setting definition

func (V2AdminOrgTeamUpdateParamsInfinityManagerSettings) MarshalJSON 

func (r V2AdminOrgTeamUpdateParamsInfinityManagerSettings) MarshalJSON() (data []byte, err error)

type V2AdminOrgTeamUpdateParamsRepoScanSettings 

type V2AdminOrgTeamUpdateParamsRepoScanSettings struct {
	// Allow org admin to override the org level repo scan settings
	RepoScanAllowOverride param.Field[bool] `json:"repoScanAllowOverride"`
	// Allow repository scanning by default
	RepoScanByDefault param.Field[bool] `json:"repoScanByDefault"`
	// Enable the repository scan or not. Only used in org level object
	RepoScanEnabled param.Field[bool] `json:"repoScanEnabled"`
	// Sends notification to end user after scanning is done
	RepoScanEnableNotifications param.Field[bool] `json:"repoScanEnableNotifications"`
	// Allow override settings at team level. Only used in org level object
	RepoScanEnableTeamOverride param.Field[bool] `json:"repoScanEnableTeamOverride"`
	// Allow showing scan results to CLI or UI
	RepoScanShowResults param.Field[bool] `json:"repoScanShowResults"`
}

Repo scan setting definition

func (V2AdminOrgTeamUpdateParamsRepoScanSettings) MarshalJSON 

func (r V2AdminOrgTeamUpdateParamsRepoScanSettings) MarshalJSON() (data []byte, err error)

type V2AdminOrgTeamUserAddRoleParams 

type V2AdminOrgTeamUserAddRoleParams struct {
	Roles param.Field[[]string] `query:"roles"`
}

func (V2AdminOrgTeamUserAddRoleParams) URLQuery 

func (r V2AdminOrgTeamUserAddRoleParams) URLQuery() (v url.Values)

URLQuery serializes V2AdminOrgTeamUserAddRoleParams's query parameters as `url.Values`.

type V2AdminOrgTeamUserService 

type V2AdminOrgTeamUserService struct {
	Options []option.RequestOption
}

V2AdminOrgTeamUserService contains methods and other services that help with interacting with the ngc API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewV2AdminOrgTeamUserService method instead.

func NewV2AdminOrgTeamUserService 

func NewV2AdminOrgTeamUserService(opts ...option.RequestOption) (r *V2AdminOrgTeamUserService)

NewV2AdminOrgTeamUserService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*V2AdminOrgTeamUserService) AddRole 

func (r *V2AdminOrgTeamUserService) AddRole(ctx context.Context, orgName string, teamName string, id string, body V2AdminOrgTeamUserAddRoleParams, opts ...option.RequestOption) (res *shared.User, err error)

Add user role in team.

type V2AdminOrgUserAddRoleParams 

type V2AdminOrgUserAddRoleParams struct {
	Roles param.Field[[]string] `query:"roles"`
}

func (V2AdminOrgUserAddRoleParams) URLQuery 

func (r V2AdminOrgUserAddRoleParams) URLQuery() (v url.Values)

URLQuery serializes V2AdminOrgUserAddRoleParams's query parameters as `url.Values`.

type V2AdminOrgUserService 

type V2AdminOrgUserService struct {
	Options []option.RequestOption
}

V2AdminOrgUserService contains methods and other services that help with interacting with the ngc API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewV2AdminOrgUserService method instead.

func NewV2AdminOrgUserService 

func NewV2AdminOrgUserService(opts ...option.RequestOption) (r *V2AdminOrgUserService)

NewV2AdminOrgUserService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*V2AdminOrgUserService) AddRole 

func (r *V2AdminOrgUserService) AddRole(ctx context.Context, orgName string, id string, body V2AdminOrgUserAddRoleParams, opts ...option.RequestOption) (res *shared.User, err error)

Add user role in org.

type V3OrgService 

type V3OrgService struct {
	Options []option.RequestOption
}

V3OrgService contains methods and other services that help with interacting with the ngc API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewV3OrgService method instead.

func NewV3OrgService 

func NewV3OrgService(opts ...option.RequestOption) (r *V3OrgService)

NewV3OrgService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*V3OrgService) Validate 

func (r *V3OrgService) Validate(ctx context.Context, query V3OrgValidateParams, opts ...option.RequestOption) (res *OrgInvitation, err error)

Validate org creation from proto org

type V3OrgValidateParams 

type V3OrgValidateParams struct {
	// JWT that contains org owner email and proto org identifier
	InvitationToken param.Field[string] `query:"invitation_token,required"`
}

func (V3OrgValidateParams) URLQuery 

func (r V3OrgValidateParams) URLQuery() (v url.Values)

URLQuery serializes V3OrgValidateParams's query parameters as `url.Values`.

type V3OrgsTeamsUserService 

type V3OrgsTeamsUserService struct {
	Options []option.RequestOption
}

V3OrgsTeamsUserService contains methods and other services that help with interacting with the ngc API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewV3OrgsTeamsUserService method instead.

func NewV3OrgsTeamsUserService 

func NewV3OrgsTeamsUserService(opts ...option.RequestOption) (r *V3OrgsTeamsUserService)

NewV3OrgsTeamsUserService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*V3OrgsTeamsUserService) Get 

func (r *V3OrgsTeamsUserService) Get(ctx context.Context, orgName string, teamName string, userEmailOrID string, opts ...option.RequestOption) (res *shared.User, err error)

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

type V3OrgsUserService 

type V3OrgsUserService struct {
	Options []option.RequestOption
}

V3OrgsUserService contains methods and other services that help with interacting with the ngc API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewV3OrgsUserService method instead.

func NewV3OrgsUserService 

func NewV3OrgsUserService(opts ...option.RequestOption) (r *V3OrgsUserService)

NewV3OrgsUserService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*V3OrgsUserService) Get 

func (r *V3OrgsUserService) Get(ctx context.Context, orgName string, userEmailOrID string, opts ...option.RequestOption) (res *shared.User, err error)

Get info and role/invitation in an org by email or id

Source Files

View all Source files

Directories

Path Synopsis
apierror
apiform
apijson
apiquery
pagination
param
requestconfig
testutil

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.