Get Service Provider Settings

In this article

    You can get service provider settings 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 endpoint.

    HTTP Request

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

    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 representation of the /settings/saml2/sp collection. The ServiceProviderConfigurationV3 schema is used for the collection representation.

    ServiceProviderConfigurationV3

    Property

    Type

    Description

    entityId

    string($uuid)

    System ID assigned to the identity provider in the Veeam Backup for Microsoft Azure REST API.

    assertionConsumerUrl

    string($uuid)

    URL used by the identity provider to contact the service provider with assertions about the user principal.

    hasCertificate

    boolean

    Defines whether the authentication request is encrypted.

    certificateThumbprint

    string

    Thumbprint uniquely identifying a certificate.

    Get Service Provider SettingsExample

    The following request returns service provider settings.

    Request:

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

     

    Request Header:

    Authorization: Bearer <Access-Token>

     

    Response:

    200

     

    Response Body:

    {

     "entityId": "Veeam_Backup_51.534.223.33",

     "assertionConsumerUrl": "https://51.543.223.33/api/v3/saml2",

     "hasCertificate": false

    }