loginProtectRetrieveConfig — Retrieving the Login Protect configuration

This method allows you to retrieve the current configuration settings for Login Protect, including the 2FA status and enforcement settings.

The API endpoint is: https://api.sitelock.com/v1/partner

Request format

SiteLockOnlineRequest: This element is used to delineate the full API request.
- authentication: The partner’s username, password, and branding.
  - username: The partner’s API username.
  - password: The partner’s API password.
- loginProtectRetrieveConfig: The method name.
  - site_id: The ID of the site for which to retrieve the Login Protect configuration.

Example request

<SiteLockOnlineRequest>
    <authentication>
        <user>User</user>
        <password>Password</password>
    </authentication>
    <loginProtectRetrieveConfig>
        <site_id>49031907</site_id>
    </loginProtectRetrieveConfig>
</SiteLockOnlineRequest>

Response format

SiteLockOnlineResponse: This element is used to delineate the full API response.
- loginProtectRetrieveConfig: The method name.
  - config: The configuration settings for Login Protect.
    
    allow_all_users: Specifies whether all users are allowed to access protected URLs.
    
    authentication_methods: The authentication methods enabled for Login Protect.
    
    enabled: Specifies whether Login Protect is enabled.
    
    send_lp_notifications: Specifies whether Login Protect notifications are sent.
    
    urls: The list of protected URLs and their enforcement settings.
    
    url: The protected URL and its enforcement settings.
    
    pattern: The pattern used to match the URL. The possible values are:
    
    prefix: The URL must start with the specified value.
    
    suffix: The URL must end with the specified value.
    
    contains: The URL must contain the specified value.
    
    not_contains: The URL must not contain the specified value.
    
    value: The value of the URL pattern.
  - status: The status of the API response.
  - error: An error element containing an error code and an error message.

Example response

<SiteLockOnlineResponse>
    <loginProtectRetrieveConfig>
        <config>
            <allow_all_users>T</allow_all_users>
            <authentication_methods>email</authentication_methods>
            <enabled>T</enabled>
            <send_lp_notifications>T</send_lp_notifications>
            <urls>
                <url>
                    <pattern>page.html</pattern>
                    <value>\https://example.com/downloads/page.html</value>
                </url>
            </urls>
        </config>
        <status>ok</status>
    </loginProtectRetrieveConfig>
</SiteLockOnlineResponse>

Error response

<SiteLockOnlineResponse>
    <loginProtectRetrieveConfig>
        <error code="NNNN">Error Msg…XXXX</error>
    </loginProtectRetrieveConfig>
</SiteLockOnlineResponse>