Tokens

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

Create an application token.

post

Use to create application tokens. Select a token using the grant_type parameter.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Header parameters

User-AgentstringOptional

Body

application/json

grantTypeundefined · enumOptionalPossible values:

appIDstringOptional

appSecretstringOptional

codestringOptional

redirectUristringOptional

refreshTokenstringOptional

usernamestringOptional

passwordstringOptional

clientIDstringOptional

Responses

200

Executed successfully.

application/json

accessTokenstringOptional

idTokenstringOptional

refreshTokenstringOptional

externalTokenstringOptional

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: 170

{
  "grantType": "app_token",
  "appID": "text",
  "appSecret": "text",
  "code": "text",
  "redirectUri": "text",
  "refreshToken": "text",
  "username": "text",
  "password": "text",
  "clientID": "text"
}

{
  "accessToken": "text",
  "idToken": "text",
  "refreshToken": "text",
  "externalToken": "text"
}

Deprecated

exchange code for token

get

Exchanges an authorization code for an access token. The authorization code is retrieved from the authorization server.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Query parameters

redirect_uristringRequired

The redirect uri to redirect to after the authorization server completes the authorization flow

codestringRequired

The exchange code retrieved from the idp server

Responses

200

Executed successfully.

application/json

accessTokenstringOptional

idTokenstringOptional

refreshTokenstringOptional

externalTokenstringOptional

400

Bad request.

application/json

500

unexpected error

application/json

503

unexpected error

application/json

get/v1/k8s/auth/token/exchange

HTTPcURLJavaScriptPython

GET /v1/k8s/auth/token/exchange?redirect_uri=text&code=text HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "accessToken": "text",
  "idToken": "text",
  "refreshToken": "text",
  "externalToken": "text"
}

Deprecated

refresh token

post

Refreshes an user tokens. The refresh token is retrieved from the authorization server.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Query parameters

refresh_tokenstringRequired

The refresh token retrieved from the idp server

Responses

200

Executed successfully.

application/json

accessTokenstringOptional

idTokenstringOptional

refreshTokenstringOptional

externalTokenstringOptional

400

Bad request.

application/json

500

unexpected error

application/json

503

unexpected error

application/json

post/v1/k8s/auth/oauth/tokens/refresh

HTTPcURLJavaScriptPython

POST /v1/k8s/auth/oauth/tokens/refresh?refresh_token=text HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "accessToken": "text",
  "idToken": "text",
  "refreshToken": "text",
  "externalToken": "text"
}

Deprecated

get application token

post

Retrieve access token for an application. The application token is retrieved from the authorization server.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Body

application/json

idstringRequired

namestringRequired

secretstringRequired

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"
}