get (subuser)

Queries a domain's sub-user data.

Request parameters for get (subuser)

Standard parameters

  • action = get
  • object = subuser
  • registrant_ip = valid IP address of the registrant (optional)
  • username = name of the user (parent) account

Attributes

Parameters within the attributes associative array are described below.

Parameter name

Obligation

Definition/Value

domain

Required

The relevant domain.

Response parameters for get (subuser)

Standard parameters

  • action = reply
  • object = subuser
  • is_success = a Boolean is returned, indicating success or failure of the
    request
  • response_code = response code indicating outcome of the request
  • response_text = message describing the outcome of the request

Attributes

If the request is successful, the attributes associative array may include the
following. (If there is no sub-user on the domain, the attributes are empty.)

Parameter name

Obligation

Definition/Value

d

Returned if is_success = true

The sub-user's ID.

permission

Returned if is_success = true

The sub-user's permission level. The permissio value is a bit mask indicating which parts of th domain information the sub-user can change.

  • 1—Owner
  • 2—Admin
  • 4—Billing
  • 8—Tech
  • 16—Nameservers
  • 32—Rsp_whois_info

username

Returned if is_success = true

The sub-user's username.

Examples for get (subuser)

Request

<?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="action">get</item>
                <item key="object">subuser</item>
                <item key="domain">yourdomain.com</item>
                <item key="username">aaaa</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="action">REPLY</item>
                <item key="object">SUBUSER</item>
                <item key="is_success">1</item>
                <item key="response_code">200</item>
                <item key="response_text">Command Successful</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="permission">2</item>
                        <item key="username">subludak</item>
                        <item key="id">2532880</item>
                    </dt_assoc>
                </item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>