Get Identity Provider Settings

In this article

    You can get identity provider settings.

    Request

    To retrieve the identity provider configuration, send the HTTP GET request to the /settings/saml2/idp endpoint.

    HTTP Request

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

    Query Parameters

    To control the amount and order of data in the response, you can use the following query parameters:

    Query Parameter

    Value

    Description

    includeDisabled

    boolean

    Defines whether Veeam Backup for Microsoft Azure must return disabled identity providers.

    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/idp collection. The IdentityProviderConfigurationV3 schema is used for the collection representation.

    Get Identity Provider SettingsExample

    The following request returns an indentity provider settings.

    Request:

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

     

    Request Header:

    Authorization: Bearer <Access-Token>

     

    Response:

    200

     

    Response Body:

    {

     "entityId": "https://sts.windows.net/1d8c765f-43bf-42c8-346g-e97c45a142d4/",

     "loginUrl": "https://login.microsoftonline.com/1d8c765f-43bf-42c8-346g-e97c45a142d4/saml2",

     "enabled": true

    }