loginProtectModifyConfig — Modifying the Login Protect configuration

This method allows you to modify the 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.
- loginProtectModifyConfig: The method name.
  - site_id: The ID of the site for which to modify the Login Protect configuration.
  - enabled: Specifies whether to enable or disable Login Protect.
  - allow_all_users: Specifies whether to allow all users to access protected URLs.
  - specific_users_list: A list of users who are allowed to access protected URLs (if allow_all_users is false).
  - send_lp_notifications: Specifies whether to send Login Protect notifications.
  - authentication_methods: The authentication methods to enable for Login Protect.
  - urls: The list of protected URLs and their enforcement settings.
    
    url: The protected URL and its enforcement settings.
    
    value: The URL to protect.
    
    pattern: The pattern used to match the URL. The valid 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.

Example request

<SiteLockOnlineRequest>
    <authentication>
        <user>User</user>
        <password>Password</password>
    </authentication>
    <loginProtectModifyConfig>
        <site_id>1234</site_id>
        <enabled>yes</enabled>
        <allow_all_users>yes</allow_all_users>
        <specific_users_list>true</specific_users_list>
        <send_lp_notifications>yes</send_lp_notifications>
        <authentication_methods>url</authentication_methods>
        <urls>
            <url>
                <value>\https://example.com/page1</value>
                <pattern>page.html</pattern>
            </url>
        </urls>
    </loginProtectModifyConfig>
</SiteLockOnlineRequest>

Response format

SiteLockOnlineResponse: This element is used to delineate the full API response.
- loginProtectModifyConfig: The method name.
  - message: A message providing additional information about the result of the request.
  - status: The status of the API response.
  - error: An error element containing an error code and an error message.

Example response

<SiteLockOnlineResponse>
    <loginProtectModifyConfig>
        <message>OK</message>
        <status>ok</status>
    </loginProtectModifyConfig>
</SiteLockOnlineResponse>

Example error response

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