update_dv_auth

Changes the authentication method for a domain-vetted RapidSSL, Geotrust or Comodo certificate, or sends an immediate request for validation of a domain-vetted RapidSSL. Attributes used are dv_auth_method or dv_auth_on_demand_check, respectively.

Request parameters for update_dv_auth

Standard parameters

  • action = update_dv_auth
  • object = trust_service

Attributes:

Parameters within the attributes associative array are described below.

Parameter name

Obligation

Definition/Value

order_id

Required.

The ID number of SSL service order.

Example: 17559

dv_auth_on_demaind_check

Optional.

Required to send an immediate request for validation.

1 is the only valid value for dv_on_demand_check

dv_auth_method

Optional.

Required to make a change to the authentication method.

Possible values:

  • file
  • DNS
  • email

Response parameters for update_dv_auth

Standard parameters

  • action = update_dv_auth: reply
  • object = trust_service
  • response_ text = message describing the outcome of requested attributes
  • response_code = code indicating outcome of request
  • is_success = boolean indication success or failure of request

Attributes:

If the request is successful, the attributes associative array may include the
following:

Parameter name

Obligation

Definition/Value

order_id

always returned

The ID number of SSL service order example 17559

Examples for update_dv_auth_check (dv_auth_on_demand_check)

Request

<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="action">update_dv_auth</item>
                <item key="object">trust_service</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="order_id">16679</item>
                        <item key="dv_auth_on_demand_check">1</item>
                    </dt_assoc>
                </item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="action">update_dv_auth</item>
                <item key="object">trust_service</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="order_id">16680</item>
                        <item key="dv_auth_on_demand_check">1</item>
                    </dt_assoc>
                </item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="action">update_dv_auth</item>
                <item key="object">trust_service</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="order_id">16682</item>
                        <item key="dv_auth_on_demand_check">1</item>
                    </dt_assoc>
                </item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

Response

<?xml version='1.0' encoding="UTF-8" standalone="no"?>
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="object">TRUST_SERVICE</item>
                <item key="response_text">Command completed successfully.</item>
                <item key="action">UPDATE_DV_AUTH:REPLY</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="order_id">16679</item>
                    </dt_assoc>
                </item>
                <item key="response_code">200</item>
                <item key="is_success">1</item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>
<?xml version='1.0' encoding="UTF-8" standalone="no"?>
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="object">TRUST_SERVICE</item>
                <item key="response_text">Command completed successfully.</item>
                <item key="action">UPDATE_DV_AUTH:REPLY</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="order_id">16679</item>
                    </dt_assoc>
                </item>
                <item key="response_code">200</item>
                <item key="is_success">1</item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="object">TRUST_SERVICE</item>
                <item key="response_text">on-demand check is not supported for EMAIL Auth Method</item>
                <item key="action">UPDATE_DV_AUTH:REPLY</item>
                <item key="response_code">465</item>
                <item key="error_details">
                    <dt_array>
                        <item key="0">
                            <dt_assoc>
                                <item key="error_detail">on-demand check is not supported for EMAIL Auth Method</item>
                                <item key="field_name">dv_on_demand_check</item>
                                <item key="error_code">465</item>
                            </dt_assoc>
                        </item>
                    </dt_array>
                </item>
                <item key="is_success">0</item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

Examples for update_dv_auth_check (dv_auth_method)

Request

<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="action">update_dv_auth</item>
                <item key="object">trust_service</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="order_id">17559</item>
                        <item key="dv_auth_method">file</item>
                    </dt_assoc>
                </item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="action">update_dv_auth</item>
                <item key="object">trust_service</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="order_id">17559</item>
                        <item key="dv_auth_method">dns</item>
                    </dt_assoc>
                </item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="action">update_dv_auth</item>
                <item key="object">trust_service</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="order_id">17559</item>
                        <item key="dv_auth_method">email</item>
                        <item key='approver_email'>[email protected]</item>
                            </dt_assoc>
                        </item>
                 </dt_assoc>
                </data_block> 
    </body>
</OPS_envelope>

Response

<?xml version='1.0' encoding="UTF-8" standalone="no" ?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="object">TRUST_SERVICE</item>
                <item key="response_text">Command completed successfully.</item>
                <item key="action">UPDATE_DV_AUTH:REPLY</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="order_id">17559</item>
                    </dt_assoc>
                </item>
                <item key="response_code">200</item>
                <item key="is_success">1</item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>