Getting Authorization Tokens

Veeam Service Provider Console RESTful API authorization with Swagger UI involves the following procedures:

  1. Obtain an access token:
  1. On the VSPC REST 3.0 page, expand the Authentication resource and click POST /authentication/usernamepassword.
  2. Click the Try it out button.
  3. In the username and password fields, specify the credentials of a user with the privileges of a user that has access to Veeam Service Provider Console RESTful API.
  4. Click Execute.

Wait for the response from the server. A successfully completed operation returns the 200 OK response code and an access token in the response body.

Authorization Request

  1. Copy the access token.
  2. Click the Authorize button. The Available authorizations window will open.
  3. In the Value field, type Bearer and the space character, then paste the access token.
  4. Click Authorize.

Obtaining the Tokens

  1. When the access token expires, use the refresh token:
  1. On the VSPC REST 3.0 page, expand the Authentication resource and click POST /authentication/refresh.
  2. Click Try it out.
  3. In the refreshToken field, insert the refresh token saved locally.
  4. Click Execute.

Using the Refresh Token

Wait for the response from the server. A successfully completed operation returns the 200 Success response code and a new pair of tokens in the response body.

  1. When you finish working with Veeam Service Provider Console RESTful API:
  1. Click the Authorize button. The Available authorizations window will open.
  2. Click the Logout button.

Related Topics

Authorization and Security

I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.