change_domain

Syntax

{
    <credentials object>, 
    "domains": <domain> 
    "attributes":
      {
        <key value pairs>
      }, 
   }
}

Request fields for change_domain

Request fields for change_domain method:

Attributes fields

You can specify the following fields within the attributes array.

📘

Domain Reassignment

Company admins may be configured to control multiple Companies. Currently, you must request that OpenSRS set this up for you - both companies must be controlled by the same billing entity.

Once set up, the company names you can reassign to will be included in the extra_info.roles section of the authenticate response.

It may be wise to always reset the brand to null before or during the domain reassignment, as the current brand will not be under the receiving company. If set at the domain level, the current brand will continue to work after reassignment, but it may cause confusion to anyone looking at the domain in the future.

Response fields for change_domain

The following fields may be returned in response to the change_domain
method:

Examples for change_domain

Example 1

Changes the allow attribute.

Request

{
  "credentials": {
    "user": "[email protected]",
    "password": "sw0rdf1sh"
  },
  "domain": "example.com",
  "attributes": {
    "allow": [
      "*@example.com",
      "[email protected]"
    ] 
  }
}

Response

{
    "success": true
}

Example 2

Adds a note to the domain

Request

{
  "credentials": {
    "user": "[email protected]",
    "password": "sw0rdf1sh"
  },
  "domain": "example.com",
  "attributes": {
    "notes_external: "Has not paid.\nDo NOT enable without consulting 
Finance."
  } 
}

Response

{
    "success": true
}

Example 3

Attempts to create a domain that already exists (with create_only flag)

Request

{
  "attributes":{},
  "domain":"gob.com",
  "create_only":true,
  "credentials":{...}
}

Response

{
  "success":false,
  "error_number":23,
  "error":"Object already exists",
  "audit":"anger67_50c235f128"
}