Tokens

Use tokens to facilitate authentication to the NVIDIA Run:ai API. The API server must be configured to use the NVIDIA Run:ai identity service to validate authentication tokens.

Create an access token v1

post

Create tokens using the grant_type parameter.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Body

application/json

grantTypeundefined · enumOptionalPossible values:

appIDstring · max: 255OptionalDeprecated

appSecretstring · max: 500OptionalDeprecated

codestring · max: 2048Optional

redirectUristring · max: 2048Optional

refreshTokenstring · max: 4096Optional

usernamestring · max: 255Optional

passwordstring · max: 255Optional

clientIDstring · max: 255Optional

clientSecretstring · max: 500Optional

externalTokenstring · max: 4096Optional

Responses

200

Executed successfully.

application/json

accessTokenstringOptional

idTokenstringOptional

refreshTokenstringOptional

expiresInintegerOptional

Token lifetime in seconds

400

Bad request.

application/json

500

unexpected error

application/json

503

unexpected error

application/json

post

/api/v1/token

HTTPcURLJavaScriptPython

POST /api/v1/token HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 86

{
  "grantType": "client_credentials",
  "clientID": "clientID",
  "clientSecret": "clientSecret"
}

client_credentialsrefresh_tokenexchange_tokenexternal_token_exchangeapp_token (deprecated)

{
  "accessToken": "text",
  "idToken": "text",
  "refreshToken": "text",
  "expiresIn": 1
}

Create an access token v2

post

Use this endpoint to obtain an access token. Compliant with standard OAuth2 protocol and supports the common OAuth2 grant types.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Body

application/x-www-form-urlencoded

grant_typestring · enumRequired

The OAuth2 grant type that determines how the token will be issued.

Possible values:

client_idstringOptional

OAuth2 client identifier

client_secretstring · passwordOptional

OAuth2 client secret

usernamestringOptional

Resource owner username (for password grant)

passwordstring · passwordOptional

The password of the resource owner. Required only when using the password grant type.

refresh_tokenstringOptional

The refresh token used to obtain a new access token. Required only when using the refresh_token grant type.

codestringOptional

Authorization code issued by the authorization server. Used in the authorization_code grant to exchange the code for an access token.

redirect_uristringOptional

The redirect URI used during the authorization request. Required for the authorization_code grant to validate the redirect destination.

Responses

200

Successfully issued token

application/json

access_tokenstringRequired

The access token issued by the authorization server

token_typestringRequired

The type of the token issued (typically "Bearer")

Example: Bearer

expires_inintegerOptional

The lifetime in seconds of the access token

Example: 3600

refresh_tokenstringOptional

The refresh token, which can be used to obtain new access tokens

id_tokenstringOptional

ID Token value associated with the authenticated session (OpenID Connect)

scopestringOptional

The scope of the access token

400

Invalid request

application/json

401

Client authentication failed

application/json

500

unexpected error

application/json

503

unexpected error

application/json

post

/api/v2/token

HTTPcURLJavaScriptPython

POST /api/v2/token HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 142

"grant_type='authorization_code'&code='authorization_code_value'&redirect_uri='https://example.com/callback'&client_id='my-client-id'"

authorization_codeclient_credentialspasswordrefresh_token

{
  "access_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
  "token_type": "Bearer",
  "expires_in": 3600,
  "refresh_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
  "id_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9..."
}

Deprecated

get application token

post

Retrieve access token for an application. The application token is retrieved from the authorization server. This endpoint is deprecated. Use /api/v1/token with the grantType parameter set to app_token instead, with AppID and appSecret set accordingly to get an application token

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Body

application/json

idstring · max: 64Required

namestring · max: 255Required

secretstring · max: 500Required

Responses

200

Executed successfully.

application/json

access_tokenstringRequired

id_tokenstringRequired

400

Bad request.

application/json

500

unexpected error

application/json

503

unexpected error

application/json

post

/v1/k8s/auth/oauth/apptoken

HTTPcURLJavaScriptPython

POST /v1/k8s/auth/oauth/apptoken HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 43

{
  "id": "text",
  "name": "text",
  "secret": "text"
}

{
  "access_token": "text",
  "id_token": "text"
}