Partner Accounts

All the methods described on this page require the partner to be authenticated.

Update Billing Information

POST /partner/billing

This resource allows a partner to update billing details.

JSON Parameters:
  • name (string) – The name of the entity being billed. This is the name that will be shown on invoices. For prepaid billing, this is the name as shown on the credit card.
  • address (list<string>) – List of billing address lines. Eg. [“123 Rue St.”, “Apt. B”].
  • city (string) – Billing address city.
  • state (string) – Billing address state or province.
  • postal_code (string) – Billing address postal code.
  • country (string) – Billing address country.

The following additional parameters are required for prepaid billing:

JSON Parameters:
  • card_number (string) – The credit card number.
  • security_code (string) – The credit card security code.
  • expiration_month (int) – The credit card expiration month.
  • expiration_year (int) – The credit card expiration year.

The following response statuses are possible:

Status Codes:
  • 200 – Billing information updated successfully.
  • 400 – Invalid or missing request parameters.
  • 409 – (Credit card only) The credit card processor has rejected the provided card details (see Example Conflict Response). The response body will include code and reason fields indicating the reason for the rejection. See Paymentech Response Codes for a list of possible values for the code field.

Invoice Example:

POST /partner/billing HTTP/1.1
Content-type: text/javascript

    "name": "Internet Widgets, Inc.",
    "address": ["123 Rue St."],
    "city": "Hogtown",
    "state": "FL",
    "postal_code": "10101",
    "country": "US"

Credit Card Example:

POST /partner/billing HTTP/1.1
Content-type: text/javascript

    "name": "Acme Internet Services, Ltd.",
    "address": [
        "1 Speed Way",
        "Suite 103"
    "city": "Sitka",
    "state": "AL",
    "postal_code": "99099",
    "country": "US",
    "card_number": "378282246310005",
    "security_code": "1234",
    "expiration_month": 8,
    "expiration_year": 2016

Example Conflict Response:

HTTP/1.1 409 Conflict
Content-type: text/javascript

    "code": "05",
    "reason": "Do not honor"

API Password

POST /partner/password

Change API/Management console account password.

Request should consist of a single JSON string containing the new password.


POST /partner/password HTTP/1.1
Content-type: text/javascript


Enterprise Quota

GET /partner/quota

View quota information.

Response includes the following JSON fields:

JSON Parameters:
  • bytes_available (int) – Total space available to the enterprise to divide among its users.
  • bytes_allocated (int) – Amount of space currently allocated to enterprise users.
  • bytes_used (int) – Amount of space currently used by enterprise users.
  • share_count (int) – Total number of shares for enterprise users.
  • device_count (int) – Total number of devices for enterprise users.

Enterprise Features

GET /partner/features

View available enterprise features.

Response includes the following JSON fields:

JSON Parameters:
  • netkes (bool) – Enable key escrow server?
  • ldap (bool) – Enable LDAP support?
  • group_permissions (bool) – Enable group permissions?
  • signup_restrictions (bool) – Enable signup restrictions?
  • email_as_username (bool) – Identify users by email rather than username?

Enterprise Settings

GET /partner/settings
POST /partner/settings

View or modify enterprise settings. A GET request will return current values for the below parameters, while a POST request will set them. You may include any number of the parameters below in a POST request.

JSON Parameters:
  • omva_url (string) – Root URL of the OpenManage Virtual Appliance.
  • support_email (string) – Email address for user support.
  • share_link_ttl (int) – Duration that generated share links are valid for in minutes.
  • autopurge_interval (int) – Automatically purge deleted blocks after autopurge_interval days (set to 0 or null to disable).
  • purgehold_duration (int) – Amount of time (in seconds) after deletion of any of the enterprise’s avatar’s blocks during which purging of those blocks is inhibited.
  • ad_domain (string) – The ActiveDirectory domain that users must be a member of. Set to null to disable domain checking.
  • signup_network_restriction (list<string>) – List of IP netblocks that are not allowed to sign up directly. Users attempting to sign up from these blocks will be directed to contact an administrator. Eg. [“”, “”]

The following response statuses are possible for a POST request:

Status Codes:
  • 200 – Settings updated successfully.
  • 400 – Invalid request parameters were included.

Global Share List

GET /shares/

List all shares defined across all users within the partner’s brand.

Query Parameters:
  • limit – Optional. Limit results to specified number.
  • offset – Optional. Start listing results at specified offset.

Client Revsions

GET /clientrevisions/

List a count of devices per revision.

Query Parameters:
  • min_revision – Optional. The minimum revision to return information on. 0 is the lowest possible revision and the default.
  • max_revision – Optional. The maximum revision to return information on. Use -1 to specify no maximum. -1 is the default.
  • max_days_since_login – Optional. The maximum age of a device in days to return information on. Use -1 to specify no maximum. -1 is the default.

Returns a JSON list with the following information for each revision in successful response:

JSON Parameters:
  • revision (int) – The client revision.
  • count (int) – The number of devices with this revision.

Table Of Contents

Previous topic

User Accounts

Next topic

Group / Plan Manipulation

This Page