Auth

Authentication module.

A collection of functions for working with vRA authentication.

codestream.api.auth.get_bearer_token(refresh_token, settings=<class 'codestream.common.VRASettings'>)

Get bearer token.

Get a bearer access token from a provided vRA URL by providing a refresh token.

This token is short-lived.

Inputs:

  • vRA URL

  • Refresh Token

Outputs:

  • Bearer Token

  • Status Code

API reference: ${VRA_URL}/iaas/api/swagger/ui/#/Login/retrieveAuthToken

codestream.api.auth.get_refresh_token(username, password, settings=<class 'codestream.common.VRASettings'>)

Get refresh token.

Get a refresh token from a provided vRA URL using a username and password.

This token is long-lived.

Inputs:

  • vRA URL

  • Username

  • Password

Outputs:

  • Refresh Token

  • Status Code

API reference: ${VRA_URL}/identity/doc/v3/api-docs/swagger-config#/LoginController/login_1