ReservedDomains: getReservedDomains

Required scopes: domain_read. Please note the Org Admin API only returns JSON, not XML.

Request

HTTP request

GET /v2/organizations/{organizationId}/reserved_domains

Parameters

Parameter NameValueDescription
Path Parameters
organizationIdstring

The organization ID Guid

Responses

CodeDescriptionReference
200

OK

ReservedDomains

SDK Method

ReservedDomains::getReservedDomains

Definitions

DocuSign.API.Organizations.Web.Models.RestApi.v2.Response.DomainResponse

Information about a reserved domain.

idstring

The ID of the reserved domain.

statusstring

The status of the request. One of:

  • unknown
  • pending
  • active
  • deactivated
  • rejected

host_namestring

The host name of the reserved domain.

txt_tokenstring

A token in form of text of the reserved domain.

identity_provider_idstring

The identity provider ID of the reserved domain.

settings[DocuSign.API.Organizations.Web.Models.RestApi.v2.Response.SettingResponse]

A list of settings of the reserved domain:

links[DocuSign.API.Organizations.Web.Models.RestApi.v2.Response.LinkResponse]

A list of useful links.

DocuSign.API.Organizations.Web.Models.RestApi.v2.Response.LinkResponse

A link to a useful URL.

relstring

The kind of linked item.

hrefstring

URL of the linked item.

DocuSign.API.Organizations.Web.Models.RestApi.v2.Response.SettingResponse

A key/value list of settings.

keystring

The key of the setting.

valueobject

The value of the setting.

typestring

The type of the setting. One of:

  • unknown
  • guid
  • text
  • integer
  • boolean
  • datetime
  • enumeration

ReservedDomains

Methods to get a list of reserved domains.

reserved_domains[DocuSign.API.Organizations.Web.Models.RestApi.v2.Response.DomainResponse]

An array that returns a list of reserved domains.

Examples

Generic JSON Response

Response
{
  "reserved_domains": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "status": "unknown",
      "host_name": "string",
      "txt_token": "string",
      "identity_provider_id": "00000000-0000-0000-0000-000000000000",
      "settings": [
        {
          "key": "string",
          "value": {},
          "type": "unknown"
        }
      ],
      "links": [
        {
          "rel": "string",
          "href": "string"
        }
      ]
    }
  ]
}
Generic XML Request/Response

Request
<Not applicable for Org Admin>
Response
<Not applicable for Org Admin>
}} />