Veeam Backup for AWS 9
REST API Reference
Related documents

Authorization (Single Sign-On)

If single sign-on (SSO) settings are configured in Veeam Backup for AWS, the /identityProvider resource collection allows a user to authenticate himself through the identity provider. For more information on how to configure SSO settings, see Identity Provider.
To learn more about the authorization process and security settings, see the Veeam Backup for AWS REST API Reference Overview, section Authorization and Security.

Get SSO URL

The HTTP GET request to the /identityProvider/signOnUrl endpoint retrieves a URL that will be used to log in to the identity provider.

Request
query Parameters
userName
string

Specifies the name of a user account retrieved from the identity provider.

Example: userName=sara_baker@companymail.com
header Parameters
x-api-version
required
string
Default: 1.7-rev0

Specifies the current version and revision of the Veeam Backup for AWS REST API.

Responses
200

OK

400

Bad Request. The request body is malformed, incomplete or otherwise invalid

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

403

Forbidden. The user sending a request does not have adequate privileges to access one or more objects specified in the request.

404

Not Found. One or more resources specified in the request could not be found in the specified resource collection.

500

Internal Server Error. The request has been received but could not be completed because of an internal error on the server side.

503

Service Unavailable

504

Gateway Timeout

get/api/v1/identityProvider/signOnUrl
Request samples 
curl -i -X GET \
  'https://helpcenter.veeam.com/api/v1/identityProvider/signOnUrl?userName=string' \
  -H 'x-api-version: 1.7-rev0'
Response samples

Request Authorization Tokens

The HTTP POST request to the /identityProvider/token endpoint allows you to authorize your access to the Veeam Backup for AWS REST API.

Request
header Parameters
x-api-version
required
string
Default: 1.7-rev0

Specifies the current version and revision of the Veeam Backup for AWS REST API.

Request Body schema: application/x-www-form-urlencoded
SamlResponse
string

Specifies a saml response obtained from the identity provider.

Responses
200

OK

400

Bad Request. The request body is malformed, incomplete or otherwise invalid

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

403

Forbidden. The user sending a request does not have adequate privileges to access one or more objects specified in the request.

500

Internal Server Error. The request has been received but could not be completed because of an internal error on the server side.

503

Service Unavailable

504

Gateway Timeout

post/api/v1/identityProvider/token
Request samples
application/x-www-form-urlencoded
SamlResponse=PHNhbWxwOlJlc3BvbnNlIElEPSJfNDMyNDQ5YTItYjNi
Response samples
application/json
[
  • {
    }
]