This is an archive version of the document. To get the most up-to-date information, see the current version.

Export Service Provider Metadata

You can export service provider settings into a metadata file that must be passed to the identity provider.

Request

To retrieve the service provider settings, send the HTTP GET request to the /settings/saml2/sp/metadata endpoint.

HTTP Request

GET https://<hostname>/api/v3/settings/saml2/sp/metadata

Request Headers

The request contains the following headers.

Header

Required

Value

Description

Authorization

Required

Bearer <Access-Token>

Authenticates a client who sends the request to the server. Must contain the access token for the current logon session in the Bearer <Access-Token> format.

Response

The server returns the following response to the client.

Response Codes

A successfully completed operation returns a response code 200 (OK).

Response Headers

The response to this request contains the following headers. The response may also include additional standard HTTP headers.

Header

Value

Description

Content-length

integer

Identifies the length of the response body message, in bytes.

Content-type

  • application/json
  • application/problem+json

Identifies the media type of the response body message.

Response Body

In the response body, Veeam Backup for Microsoft Azure returns a link to download the metadata file.

Export Service Provider MetadataExample

The following request returns a link to download the metadata file.

Request:

GET https://51.11.247.127/api/v3/settings/saml2/sp/metadata

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200

 

Response body:

Download file