| 1 |
<pre>Internet Engineering Task Force (IETF) A. Newton |
| 2 |
Request for Comments: 7483 ARIN |
| 3 |
Category: Standards Track S. Hollenbeck |
| 4 |
ISSN: 2070-1721 Verisign Labs |
| 5 |
March 2015 |
| 6 |
|
| 7 |
|
| 8 |
<span class="h1">JSON Responses for the Registration Data Access Protocol (RDAP)</span> |
| 9 |
|
| 10 |
Abstract |
| 11 |
|
| 12 |
This document describes JSON data structures representing |
| 13 |
registration information maintained by Regional Internet Registries |
| 14 |
(RIRs) and Domain Name Registries (DNRs). These data structures are |
| 15 |
used to form Registration Data Access Protocol (RDAP) query |
| 16 |
responses. |
| 17 |
|
| 18 |
Status of This Memo |
| 19 |
|
| 20 |
This is an Internet Standards Track document. |
| 21 |
|
| 22 |
This document is a product of the Internet Engineering Task Force |
| 23 |
(IETF). It represents the consensus of the IETF community. It has |
| 24 |
received public review and has been approved for publication by the |
| 25 |
Internet Engineering Steering Group (IESG). Further information on |
| 26 |
Internet Standards is available in <a href="./rfc5741#section-2">Section 2 of RFC 5741</a>. |
| 27 |
|
| 28 |
Information about the current status of this document, any errata, |
| 29 |
and how to provide feedback on it may be obtained at |
| 30 |
<a href="http://www.rfc-editor.org/info/rfc7483">http://www.rfc-editor.org/info/rfc7483</a>. |
| 31 |
|
| 32 |
Copyright Notice |
| 33 |
|
| 34 |
Copyright (c) 2015 IETF Trust and the persons identified as the |
| 35 |
document authors. All rights reserved. |
| 36 |
|
| 37 |
This document is subject to <a href="https://www.rfc-editor.org/bcp/bcp78">BCP 78</a> and the IETF Trust's Legal |
| 38 |
Provisions Relating to IETF Documents |
| 39 |
(<a href="http://trustee.ietf.org/license-info">http://trustee.ietf.org/license-info</a>) in effect on the date of |
| 40 |
publication of this document. Please review these documents |
| 41 |
carefully, as they describe your rights and restrictions with respect |
| 42 |
to this document. Code Components extracted from this document must |
| 43 |
include Simplified BSD License text as described in Section 4.e of |
| 44 |
the Trust Legal Provisions and are provided without warranty as |
| 45 |
described in the Simplified BSD License. |
| 46 |
|
| 47 |
|
| 48 |
|
| 49 |
|
| 50 |
|
| 51 |
|
| 52 |
<span class="grey">Newton & Hollenbeck Standards Track [Page 1]</span></pre> |
| 53 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-2" ></span> |
| 54 |
<span class="grey"><a href="./rfc7483">RFC 7483</a> RDAP JSON Responses March 2015</span> |
| 55 |
|
| 56 |
|
| 57 |
Table of Contents |
| 58 |
|
| 59 |
<a href="#section-1">1</a>. Introduction . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-3">3</a> |
| 60 |
<a href="#section-1.1">1.1</a>. Terminology and Definitions . . . . . . . . . . . . . . . <a href="#page-3">3</a> |
| 61 |
<a href="#section-1.2">1.2</a>. Data Model . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-4">4</a> |
| 62 |
<a href="#section-2">2</a>. Use of JSON . . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-5">5</a> |
| 63 |
<a href="#section-2.1">2.1</a>. Naming . . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-5">5</a> |
| 64 |
<a href="#section-3">3</a>. Common Data Types . . . . . . . . . . . . . . . . . . . . . . <a href="#page-7">7</a> |
| 65 |
<a href="#section-4">4</a>. Common Data Structures . . . . . . . . . . . . . . . . . . . <a href="#page-8">8</a> |
| 66 |
<a href="#section-4.1">4.1</a>. RDAP Conformance . . . . . . . . . . . . . . . . . . . . <a href="#page-8">8</a> |
| 67 |
<a href="#section-4.2">4.2</a>. Links . . . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-9">9</a> |
| 68 |
<a href="#section-4.3">4.3</a>. Notices and Remarks . . . . . . . . . . . . . . . . . . . <a href="#page-10">10</a> |
| 69 |
<a href="#section-4.4">4.4</a>. Language Identifier . . . . . . . . . . . . . . . . . . . <a href="#page-11">11</a> |
| 70 |
<a href="#section-4.5">4.5</a>. Events . . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-11">11</a> |
| 71 |
<a href="#section-4.6">4.6</a>. Status . . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-13">13</a> |
| 72 |
<a href="#section-4.7">4.7</a>. Port 43 WHOIS Server . . . . . . . . . . . . . . . . . . <a href="#page-13">13</a> |
| 73 |
<a href="#section-4.8">4.8</a>. Public IDs . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-13">13</a> |
| 74 |
<a href="#section-4.9">4.9</a>. Object Class Name . . . . . . . . . . . . . . . . . . . . <a href="#page-14">14</a> |
| 75 |
<a href="#section-4.10">4.10</a>. An Example . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-14">14</a> |
| 76 |
<a href="#section-5">5</a>. Object Classes . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-15">15</a> |
| 77 |
<a href="#section-5.1">5.1</a>. The Entity Object Class . . . . . . . . . . . . . . . . . <a href="#page-16">16</a> |
| 78 |
<a href="#section-5.2">5.2</a>. The Nameserver Object Class . . . . . . . . . . . . . . . <a href="#page-22">22</a> |
| 79 |
<a href="#section-5.3">5.3</a>. The Domain Object Class . . . . . . . . . . . . . . . . . <a href="#page-26">26</a> |
| 80 |
<a href="#section-5.4">5.4</a>. The IP Network Object Class . . . . . . . . . . . . . . . <a href="#page-38">38</a> |
| 81 |
<a href="#section-5.5">5.5</a>. Autonomous System Number Entity Object Class . . . . . . <a href="#page-42">42</a> |
| 82 |
<a href="#section-6">6</a>. Error Response Body . . . . . . . . . . . . . . . . . . . . . <a href="#page-45">45</a> |
| 83 |
<a href="#section-7">7</a>. Responding to Help Queries . . . . . . . . . . . . . . . . . <a href="#page-48">48</a> |
| 84 |
<a href="#section-8">8</a>. Responding To Searches . . . . . . . . . . . . . . . . . . . <a href="#page-48">48</a> |
| 85 |
<a href="#section-9">9</a>. Indicating Truncated Responses . . . . . . . . . . . . . . . <a href="#page-49">49</a> |
| 86 |
<a href="#section-10">10</a>. IANA Considerations . . . . . . . . . . . . . . . . . . . . . <a href="#page-52">52</a> |
| 87 |
<a href="#section-10.1">10.1</a>. RDAP JSON Media Type Registration . . . . . . . . . . . <a href="#page-52">52</a> |
| 88 |
<a href="#section-10.2">10.2</a>. JSON Values Registry . . . . . . . . . . . . . . . . . . <a href="#page-53">53</a> |
| 89 |
<a href="#section-10.2.1">10.2.1</a>. Notice and Remark Types . . . . . . . . . . . . . . <a href="#page-54">54</a> |
| 90 |
<a href="#section-10.2.2">10.2.2</a>. Status . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-56">56</a> |
| 91 |
<a href="#section-10.2.3">10.2.3</a>. Event Actions . . . . . . . . . . . . . . . . . . . <a href="#page-49">49</a> |
| 92 |
<a href="#section-10.2.4">10.2.4</a>. Roles . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-61">61</a> |
| 93 |
<a href="#section-10.2.5">10.2.5</a>. Variant Relations . . . . . . . . . . . . . . . . . <a href="#page-63">63</a> |
| 94 |
<a href="#section-11">11</a>. Security Considerations . . . . . . . . . . . . . . . . . . . <a href="#page-64">64</a> |
| 95 |
<a href="#section-12">12</a>. Internationalization Considerations . . . . . . . . . . . . . <a href="#page-64">64</a> |
| 96 |
<a href="#section-12.1">12.1</a>. Character Encoding . . . . . . . . . . . . . . . . . . . <a href="#page-64">64</a> |
| 97 |
<a href="#section-12.2">12.2</a>. URIs and IRIs . . . . . . . . . . . . . . . . . . . . . <a href="#page-64">64</a> |
| 98 |
<a href="#section-12.3">12.3</a>. Language Tags . . . . . . . . . . . . . . . . . . . . . <a href="#page-64">64</a> |
| 99 |
<a href="#section-12.4">12.4</a>. Internationalized Domain Names . . . . . . . . . . . . . <a href="#page-65">65</a> |
| 100 |
<a href="#section-13">13</a>. Privacy Considerations . . . . . . . . . . . . . . . . . . . <a href="#page-65">65</a> |
| 101 |
<a href="#section-14">14</a>. References . . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-65">65</a> |
| 102 |
<a href="#section-14.1">14.1</a>. Normative References . . . . . . . . . . . . . . . . . . <a href="#page-65">65</a> |
| 103 |
<a href="#section-14.2">14.2</a>. Informative References . . . . . . . . . . . . . . . . . <a href="#page-67">67</a> |
| 104 |
|
| 105 |
|
| 106 |
|
| 107 |
|
| 108 |
<span class="grey">Newton & Hollenbeck Standards Track [Page 2]</span></pre> |
| 109 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-3" ></span> |
| 110 |
<span class="grey"><a href="./rfc7483">RFC 7483</a> RDAP JSON Responses March 2015</span> |
| 111 |
|
| 112 |
|
| 113 |
<a href="#appendix-A">Appendix A</a>. Suggested Data Modeling with the Entity Object Class 68 |
| 114 |
<a href="#appendix-A.1">A.1</a>. Registrants and Contacts . . . . . . . . . . . . . . . . <a href="#page-68">68</a> |
| 115 |
<a href="#appendix-A.2">A.2</a>. Registrars . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-70">70</a> |
| 116 |
<a href="#appendix-B">Appendix B</a>. Modeling Events . . . . . . . . . . . . . . . . . . <a href="#page-72">72</a> |
| 117 |
<a href="#appendix-C">Appendix C</a>. Structured vs. Unstructured Addresses . . . . . . . <a href="#page-74">74</a> |
| 118 |
<a href="#appendix-D">Appendix D</a>. Secure DNS . . . . . . . . . . . . . . . . . . . . . <a href="#page-76">76</a> |
| 119 |
<a href="#appendix-E">Appendix E</a>. Motivations for Using JSON . . . . . . . . . . . . . <a href="#page-77">77</a> |
| 120 |
Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-77">77</a> |
| 121 |
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-78">78</a> |
| 122 |
|
| 123 |
<span class="h2"><a class="selflink" id="section-1" href="#section-1">1</a>. Introduction</span> |
| 124 |
|
| 125 |
This document describes responses in the JSON [<a href="./rfc7159" title=""The JavaScript Object Notation (JSON) Data Interchange Format"">RFC7159</a>] format for |
| 126 |
the queries as defined by the Registration Data Access Protocol Query |
| 127 |
Format [<a href="./rfc7482" title=""Registration Data Access Protocol (RDAP) Query Format"">RFC7482</a>]. A communication protocol for exchanging queries |
| 128 |
and responses is described in [<a href="./rfc7480" title=""HTTP Usage in the Registration Data Access Protocol (RDAP)"">RFC7480</a>]. |
| 129 |
|
| 130 |
<span class="h3"><a class="selflink" id="section-1.1" href="#section-1.1">1.1</a>. Terminology and Definitions</span> |
| 131 |
|
| 132 |
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", |
| 133 |
"SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this |
| 134 |
document are to be interpreted as described in [<a href="./rfc2119" title=""Key words for use in RFCs to Indicate Requirement Levels"">RFC2119</a>] when |
| 135 |
specified in their uppercase forms. |
| 136 |
|
| 137 |
The following list describes terminology and definitions used |
| 138 |
throughout this document: |
| 139 |
|
| 140 |
DNR: Domain Name Registry |
| 141 |
|
| 142 |
LDH: letters, digits, hyphen |
| 143 |
|
| 144 |
member: data found within an object as defined by JSON |
| 145 |
[<a href="./rfc7159" title=""The JavaScript Object Notation (JSON) Data Interchange Format"">RFC7159</a>]. |
| 146 |
|
| 147 |
object: a data structure as defined by JSON [<a href="./rfc7159" title=""The JavaScript Object Notation (JSON) Data Interchange Format"">RFC7159</a>]. |
| 148 |
|
| 149 |
object class: the definition of members that may be found in JSON |
| 150 |
objects described in this document. |
| 151 |
|
| 152 |
object instance: an instantiation or specific instance of an object |
| 153 |
class. |
| 154 |
|
| 155 |
RDAP: Registration Data Access Protocol |
| 156 |
|
| 157 |
RIR: Regional Internet Registry |
| 158 |
|
| 159 |
|
| 160 |
|
| 161 |
|
| 162 |
|
| 163 |
|
| 164 |
<span class="grey">Newton & Hollenbeck Standards Track [Page 3]</span></pre> |
| 165 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-4" ></span> |
| 166 |
<span class="grey"><a href="./rfc7483">RFC 7483</a> RDAP JSON Responses March 2015</span> |
| 167 |
|
| 168 |
|
| 169 |
<span class="h3"><a class="selflink" id="section-1.2" href="#section-1.2">1.2</a>. Data Model</span> |
| 170 |
|
| 171 |
The data model for JSON responses is specified in five sections: |
| 172 |
|
| 173 |
1. simple data types conveyed in JSON strings |
| 174 |
|
| 175 |
2. data structures specified as JSON arrays or objects that are used |
| 176 |
repeatedly when building up larger objects |
| 177 |
|
| 178 |
3. object classes representing structured data corresponding to a |
| 179 |
lookup of a single object |
| 180 |
|
| 181 |
4. arrays of objects representing structured data corresponding to a |
| 182 |
search for multiple objects |
| 183 |
|
| 184 |
5. the response to an error |
| 185 |
|
| 186 |
The object classes represent responses for two major categories of |
| 187 |
data: responses returned by RIRs for registration data related to IP |
| 188 |
addresses, reverse DNS names, and Autonomous System numbers and |
| 189 |
responses returned by DNRs for registration data related to forward |
| 190 |
DNS names. The following object classes are returned by both RIRs |
| 191 |
and DNRs: |
| 192 |
|
| 193 |
1. domains |
| 194 |
|
| 195 |
2. nameservers |
| 196 |
|
| 197 |
3. entities |
| 198 |
|
| 199 |
The information served by both RIRs and DNRs for these object classes |
| 200 |
overlap extensively and are given in this document as a unified model |
| 201 |
for both classes of service. |
| 202 |
|
| 203 |
In addition to the object classes listed above, RIRs also serve the |
| 204 |
following object classes: |
| 205 |
|
| 206 |
1. IP networks |
| 207 |
|
| 208 |
2. Autonomous System numbers |
| 209 |
|
| 210 |
Object classes defined in this document represent a minimal set of |
| 211 |
what a compliant client/server needs to understand to function |
| 212 |
correctly; however, some deployments may want to include additional |
| 213 |
object classes to suit individual needs. Anticipating this need for |
| 214 |
extension, <a href="#section-2.1">Section 2.1</a> of this document defines a mechanism for |
| 215 |
extending the JSON objects that are described in this document. |
| 216 |
|
| 217 |
|
| 218 |
|
| 219 |
|
| 220 |
<span class="grey">Newton & Hollenbeck Standards Track [Page 4]</span></pre> |
| 221 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-5" ></span> |
| 222 |
<span class="grey"><a href="./rfc7483">RFC 7483</a> RDAP JSON Responses March 2015</span> |
| 223 |
|
| 224 |
|
| 225 |
Positive responses take two forms. A response to a lookup of a |
| 226 |
single object in the registration system yields a JSON object, which |
| 227 |
is the subject of the lookup. A response to a search for multiple |
| 228 |
objects yields a JSON object that contains an array of JSON objects |
| 229 |
that are the subject of the search. In each type of response, other |
| 230 |
data structures are present within the topmost JSON object. |
| 231 |
|
| 232 |
<span class="h2"><a class="selflink" id="section-2" href="#section-2">2</a>. Use of JSON</span> |
| 233 |
|
| 234 |
<span class="h3"><a class="selflink" id="section-2.1" href="#section-2.1">2.1</a>. Naming</span> |
| 235 |
|
| 236 |
Clients of these JSON responses SHOULD ignore unrecognized JSON |
| 237 |
members in responses. Servers can insert members into the JSON |
| 238 |
responses, which are not specified in this document, but that does |
| 239 |
not constitute an error in the response. Servers that insert such |
| 240 |
unspecified members into JSON responses SHOULD have member names |
| 241 |
prefixed with a short identifier followed by an underscore followed |
| 242 |
by a meaningful name. It has been observed that these short |
| 243 |
identifiers aid software implementers with identifying the |
| 244 |
specification of the JSON member, and failure to use one could cause |
| 245 |
an implementer to assume the server is erroneously using a name from |
| 246 |
this specification. This allowance does not apply to jCard [<a href="./rfc7095" title=""jCard: The JSON Format for vCard"">RFC7095</a>] |
| 247 |
objects. The full JSON name (the prefix plus the underscore plus the |
| 248 |
meaningful name) SHOULD adhere to the character and name limitations |
| 249 |
of the prefix registry described in [<a href="./rfc7480" title=""HTTP Usage in the Registration Data Access Protocol (RDAP)"">RFC7480</a>]. Failure to use these |
| 250 |
limitations could result in slower adoption as these limitations have |
| 251 |
been observed to aid some client programming models. |
| 252 |
|
| 253 |
Consider the following JSON response with JSON members, all of which |
| 254 |
are specified in this document. |
| 255 |
|
| 256 |
{ |
| 257 |
"handle" : "ABC123", |
| 258 |
"remarks" : |
| 259 |
[ |
| 260 |
{ |
| 261 |
"description" : |
| 262 |
[ |
| 263 |
"She sells sea shells down by the sea shore.", |
| 264 |
"Originally written by Terry Sullivan." |
| 265 |
] |
| 266 |
} |
| 267 |
] |
| 268 |
} |
| 269 |
|
| 270 |
Figure 1 |
| 271 |
|
| 272 |
|
| 273 |
|
| 274 |
|
| 275 |
|
| 276 |
<span class="grey">Newton & Hollenbeck Standards Track [Page 5]</span></pre> |
| 277 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-6" ></span> |
| 278 |
<span class="grey"><a href="./rfc7483">RFC 7483</a> RDAP JSON Responses March 2015</span> |
| 279 |
|
| 280 |
|
| 281 |
If The Registry of the Moon desires to express information not found |
| 282 |
in this specification, it might select "lunarNic" as its identifying |
| 283 |
prefix and insert, as an example, the member named |
| 284 |
"lunarNic_beforeOneSmallStep" to signify registrations occurring |
| 285 |
before the first moon landing and the member named |
| 286 |
"lunarNic_harshMistressNotes" that contains other descriptive text. |
| 287 |
|
| 288 |
Consider the following JSON response with JSON names, some of which |
| 289 |
should be ignored by clients without knowledge of their meaning. |
| 290 |
|
| 291 |
{ |
| 292 |
"handle" : "ABC123", |
| 293 |
"lunarNic_beforeOneSmallStep" : "TRUE THAT!", |
| 294 |
"remarks" : |
| 295 |
[ |
| 296 |
{ |
| 297 |
"description" : |
| 298 |
[ |
| 299 |
"She sells sea shells down by the sea shore.", |
| 300 |
"Originally written by Terry Sullivan." |
| 301 |
] |
| 302 |
} |
| 303 |
], |
| 304 |
"lunarNic_harshMistressNotes" : |
| 305 |
[ |
| 306 |
"In space,", |
| 307 |
"nobody can hear you scream." |
| 308 |
] |
| 309 |
} |
| 310 |
|
| 311 |
Figure 2 |
| 312 |
|
| 313 |
Insertion of unrecognized members ignored by clients may also be used |
| 314 |
for future revisions to this specification. |
| 315 |
|
| 316 |
Clients processing JSON responses need to be prepared for members |
| 317 |
representing registration data specified in this document to be |
| 318 |
absent from a response. In other words, servers are free to not |
| 319 |
include JSON members containing registration data based on their own |
| 320 |
policies. |
| 321 |
|
| 322 |
Finally, all JSON names specified in this document are case |
| 323 |
sensitive. Both servers and clients MUST transmit and process them |
| 324 |
using the specified character case. |
| 325 |
|
| 326 |
|
| 327 |
|
| 328 |
|
| 329 |
|
| 330 |
|
| 331 |
|
| 332 |
<span class="grey">Newton & Hollenbeck Standards Track [Page 6]</span></pre> |
| 333 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-7" ></span> |
| 334 |
<span class="grey"><a href="./rfc7483">RFC 7483</a> RDAP JSON Responses March 2015</span> |
| 335 |
|
| 336 |
|
| 337 |
<span class="h2"><a class="selflink" id="section-3" href="#section-3">3</a>. Common Data Types</span> |
| 338 |
|
| 339 |
JSON [<a href="./rfc7159" title=""The JavaScript Object Notation (JSON) Data Interchange Format"">RFC7159</a>] defines the data types of a number, character string, |
| 340 |
boolean, array, object, and null. This section describes the |
| 341 |
semantics and/or syntax reference for common, JSON character strings |
| 342 |
used in this document. |
| 343 |
|
| 344 |
handle: DNRs and RIRs have registry-unique identifiers that |
| 345 |
may be used to specifically reference an object |
| 346 |
instance. The semantics of this data type as found |
| 347 |
in this document are to be a registry-unique |
| 348 |
reference to the closest enclosing object where the |
| 349 |
value is found. The data type names "registryId", |
| 350 |
"roid", "nic-handle", "registrationNo", etc., are |
| 351 |
terms often synonymous with this data type. In |
| 352 |
this document, the term "handle" is used. The term |
| 353 |
exposed to users by clients is a presentation issue |
| 354 |
beyond the scope of this document. |
| 355 |
|
| 356 |
IPv4 addresses: The representation of IPv4 addresses in this |
| 357 |
document uses the dotted-decimal notation. An |
| 358 |
example of this textual representation is |
| 359 |
"192.0.2.0". |
| 360 |
|
| 361 |
IPv6 addresses: The representation of IPv6 addresses in this |
| 362 |
document follow the forms outlined in [<a href="./rfc5952" title=""A Recommendation for IPv6 Address Text Representation"">RFC5952</a>]. |
| 363 |
An example of this textual representation is |
| 364 |
"2001:db8::1:0:0:1". |
| 365 |
|
| 366 |
country codes: Where the identity of a geopolitical nation or |
| 367 |
country is needed, these identities are represented |
| 368 |
with the alpha-2 or two-character country code |
| 369 |
designation as defined in [<a href="#ref-ISO.3166.1988">ISO.3166.1988</a>]. The |
| 370 |
alpha-2 representation is used because it is freely |
| 371 |
available, whereas the alpha-3 and numeric-3 |
| 372 |
standards are not. |
| 373 |
|
| 374 |
LDH names: Textual representations of DNS names where the |
| 375 |
labels of the domain are all "letters, digits, |
| 376 |
hyphen" labels as described by [<a href="./rfc5890" title=""Internationalized Domain Names for Applications (IDNA): Definitions and Document Framework"">RFC5890</a>]. Trailing |
| 377 |
periods are optional. |
| 378 |
|
| 379 |
Unicode names: Textual representations of DNS names where one or |
| 380 |
more of the labels are U-labels as described by |
| 381 |
[<a href="./rfc5890" title=""Internationalized Domain Names for Applications (IDNA): Definitions and Document Framework"">RFC5890</a>]. Trailing periods are optional. |
| 382 |
|
| 383 |
dates and times: The syntax for values denoting dates and times is |
| 384 |
defined in [<a href="./rfc3339" title=""Date and Time on the Internet: Timestamps"">RFC3339</a>]. |
| 385 |
|
| 386 |
|
| 387 |
|
| 388 |
<span class="grey">Newton & Hollenbeck Standards Track [Page 7]</span></pre> |
| 389 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-8" ></span> |
| 390 |
<span class="grey"><a href="./rfc7483">RFC 7483</a> RDAP JSON Responses March 2015</span> |
| 391 |
|
| 392 |
|
| 393 |
URIs: The syntax for values denoting a Uniform Resource |
| 394 |
Identifier (URI) is defined by [<a href="./rfc3986" title=""Uniform Resource Identifier (URI): Generic Syntax"">RFC3986</a>]. |
| 395 |
|
| 396 |
Contact information is defined using jCards as described in |
| 397 |
[<a href="./rfc7095" title=""jCard: The JSON Format for vCard"">RFC7095</a>]. |
| 398 |
|
| 399 |
<span class="h2"><a class="selflink" id="section-4" href="#section-4">4</a>. Common Data Structures</span> |
| 400 |
|
| 401 |
This section defines common data structures used in responses and |
| 402 |
object classes. |
| 403 |
|
| 404 |
<span class="h3"><a class="selflink" id="section-4.1" href="#section-4.1">4.1</a>. RDAP Conformance</span> |
| 405 |
|
| 406 |
The data structure named "rdapConformance" is an array of strings, |
| 407 |
each providing a hint as to the specifications used in the |
| 408 |
construction of the response. This data structure appears only in |
| 409 |
the topmost JSON object of a response. |
| 410 |
|
| 411 |
An example rdapConformance data structure: |
| 412 |
|
| 413 |
"rdapConformance" : |
| 414 |
[ |
| 415 |
"rdap_level_0" |
| 416 |
] |
| 417 |
|
| 418 |
Figure 3 |
| 419 |
|
| 420 |
The string literal "rdap_level_0" signifies conformance with this |
| 421 |
specification. When custom JSON values are inserted into responses, |
| 422 |
conformance to those custom specifications MUST use a string prefixed |
| 423 |
with the appropriate identifier from the IANA RDAP Extensions |
| 424 |
registry specified in [<a href="./rfc7480" title=""HTTP Usage in the Registration Data Access Protocol (RDAP)"">RFC7480</a>]. For example, if the fictional |
| 425 |
Registry of the Moon wants to signify that their JSON responses are |
| 426 |
conformant with their registered extensions, the string used might be |
| 427 |
"lunarNIC_level_0". These prefixes aid the identification of |
| 428 |
specifications for software implementers, and failure to use them |
| 429 |
could result in slower adoption of extensions. |
| 430 |
|
| 431 |
Example rdapConformance structure with custom extensions noted: |
| 432 |
|
| 433 |
"rdapConformance" : |
| 434 |
[ |
| 435 |
"rdap_level_0", |
| 436 |
"lunarNic_level_0" |
| 437 |
] |
| 438 |
|
| 439 |
Figure 4 |
| 440 |
|
| 441 |
|
| 442 |
|
| 443 |
|
| 444 |
<span class="grey">Newton & Hollenbeck Standards Track [Page 8]</span></pre> |
| 445 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-9" ></span> |
| 446 |
<span class="grey"><a href="./rfc7483">RFC 7483</a> RDAP JSON Responses March 2015</span> |
| 447 |
|
| 448 |
|
| 449 |
<span class="h3"><a class="selflink" id="section-4.2" href="#section-4.2">4.2</a>. Links</span> |
| 450 |
|
| 451 |
The "links" array is found in data structures to signify links to |
| 452 |
other resources on the Internet. The relationship of these links is |
| 453 |
defined by the IANA registry described by [<a href="./rfc5988" title=""Web Linking"">RFC5988</a>]. |
| 454 |
|
| 455 |
The following is an example of the link structure: |
| 456 |
|
| 457 |
{ |
| 458 |
"value" : "http://example.com/context_uri", |
| 459 |
"rel" : "self", |
| 460 |
"href" : "http://example.com/target_uri", |
| 461 |
"hreflang" : [ "en", "ch" ], |
| 462 |
"title" : "title", |
| 463 |
"media" : "screen", |
| 464 |
"type" : "application/json" |
| 465 |
} |
| 466 |
|
| 467 |
Figure 5 |
| 468 |
|
| 469 |
The JSON name/values of "rel", "href", "hreflang", "title", "media", |
| 470 |
and "type" correspond to values found in <a href="./rfc5988#section-5">Section 5 of [RFC5988]</a>. The |
| 471 |
"value" JSON value is the context URI as described by [<a href="./rfc5988" title=""Web Linking"">RFC5988</a>]. The |
| 472 |
"href" JSON value MUST be specified. All other JSON values are |
| 473 |
OPTIONAL. |
| 474 |
|
| 475 |
This is an example of the "links" array as it might be found in an |
| 476 |
object class: |
| 477 |
|
| 478 |
"links" : |
| 479 |
[ |
| 480 |
{ |
| 481 |
"value" : "http://example.com/ip/2001:db8::123", |
| 482 |
"rel" : "self", |
| 483 |
"href" : "http://example.com/ip/2001:db8::123", |
| 484 |
"type" : "application/rdap+json" |
| 485 |
}, |
| 486 |
{ |
| 487 |
"value" : "http://example.com/ip/2001:db8::123", |
| 488 |
"rel" : "up", |
| 489 |
"href" : "http://example.com/ip/2001:db8::/48", |
| 490 |
"type" : "application/rdap+json" |
| 491 |
} |
| 492 |
|
| 493 |
] |
| 494 |
|
| 495 |
Figure 6 |
| 496 |
|
| 497 |
|
| 498 |
|
| 499 |
|
| 500 |
<span class="grey">Newton & Hollenbeck Standards Track [Page 9]</span></pre> |
| 501 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-10" ></span> |
| 502 |
<span class="grey"><a href="./rfc7483">RFC 7483</a> RDAP JSON Responses March 2015</span> |
| 503 |
|
| 504 |
|
| 505 |
<span class="h3"><a class="selflink" id="section-4.3" href="#section-4.3">4.3</a>. Notices and Remarks</span> |
| 506 |
|
| 507 |
The "notices" and "remarks" data structures take the same form. The |
| 508 |
notices structure denotes information about the service providing |
| 509 |
RDAP information and/or information about the entire response, |
| 510 |
whereas the remarks structure denotes information about the object |
| 511 |
class that contains it (see <a href="#section-5">Section 5</a> regarding object classes). |
| 512 |
|
| 513 |
Both are arrays of objects. Each object contains an optional "title" |
| 514 |
string representing the title of the object, an optional "type" |
| 515 |
string denoting a registered type of remark or notice (see |
| 516 |
<a href="#section-10.2.1">Section 10.2.1</a>), an array of strings named "description" for the |
| 517 |
purposes of conveying any descriptive text, and an optional "links" |
| 518 |
array as described in <a href="#section-4.2">Section 4.2</a>. |
| 519 |
|
| 520 |
An example of the notices data structure: |
| 521 |
|
| 522 |
"notices" : |
| 523 |
[ |
| 524 |
{ |
| 525 |
"title" : "Terms of Use", |
| 526 |
"description" : |
| 527 |
[ |
| 528 |
"Service subject to The Registry of the Moon's TOS.", |
| 529 |
"Copyright (c) 2020 LunarNIC" |
| 530 |
], |
| 531 |
"links" : |
| 532 |
[ |
| 533 |
{ |
| 534 |
"value" : "http://example.net/entity/XXXX", |
| 535 |
"rel" : "alternate", |
| 536 |
"type" : "text/html", |
| 537 |
"href" : "http://www.example.com/terms_of_use.html" |
| 538 |
} |
| 539 |
] |
| 540 |
} |
| 541 |
] |
| 542 |
|
| 543 |
Figure 7 |
| 544 |
|
| 545 |
It is the job of the clients to determine line breaks, spacing, and |
| 546 |
display issues for sentences within the character strings of the |
| 547 |
"description" array. Each string in the "description" array contains |
| 548 |
a single complete division of human-readable text indicating to |
| 549 |
clients where there are semantic breaks. |
| 550 |
|
| 551 |
|
| 552 |
|
| 553 |
|
| 554 |
|
| 555 |
|
| 556 |
<span class="grey">Newton & Hollenbeck Standards Track [Page 10]</span></pre> |
| 557 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-11" ></span> |
| 558 |
<span class="grey"><a href="./rfc7483">RFC 7483</a> RDAP JSON Responses March 2015</span> |
| 559 |
|
| 560 |
|
| 561 |
An example of the remarks data structure: |
| 562 |
|
| 563 |
"remarks" : |
| 564 |
[ |
| 565 |
{ |
| 566 |
"description" : |
| 567 |
[ |
| 568 |
"She sells sea shells down by the sea shore.", |
| 569 |
"Originally written by Terry Sullivan." |
| 570 |
] |
| 571 |
} |
| 572 |
] |
| 573 |
|
| 574 |
Figure 8 |
| 575 |
|
| 576 |
Note that objects in the "remarks" array may also have a "links" |
| 577 |
array. |
| 578 |
|
| 579 |
While the "title" and "description" fields are intended primarily for |
| 580 |
human consumption, the "type" string contains a well-known value to |
| 581 |
be registered with IANA (see <a href="#section-10.2.1">Section 10.2.1</a>) for programmatic use. |
| 582 |
|
| 583 |
An example of the remarks data structure: |
| 584 |
|
| 585 |
"remarks" : |
| 586 |
[ |
| 587 |
{ |
| 588 |
"type" : "object truncated due to authorization", |
| 589 |
"description" : |
| 590 |
[ |
| 591 |
"Some registration data may not have been given.", |
| 592 |
"Use proper authorization credentials to see all of it." |
| 593 |
] |
| 594 |
} |
| 595 |
] |
| 596 |
|
| 597 |
Figure 9 |
| 598 |
|
| 599 |
While the "remarks" array will appear in many object classes in a |
| 600 |
response, the "notices" array appears only in the topmost object of a |
| 601 |
response. |
| 602 |
|
| 603 |
|
| 604 |
|
| 605 |
|
| 606 |
|
| 607 |
|
| 608 |
|
| 609 |
|
| 610 |
|
| 611 |
|
| 612 |
<span class="grey">Newton & Hollenbeck Standards Track [Page 11]</span></pre> |
| 613 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-12" ></span> |
| 614 |
<span class="grey"><a href="./rfc7483">RFC 7483</a> RDAP JSON Responses March 2015</span> |
| 615 |
|
| 616 |
|
| 617 |
<span class="h3"><a class="selflink" id="section-4.4" href="#section-4.4">4.4</a>. Language Identifier</span> |
| 618 |
|
| 619 |
This data structure consists solely of a name/value pair, where the |
| 620 |
name is "lang" and the value is a string containing a language |
| 621 |
identifier as described in [<a href="./rfc5646" title=""Tags for Identifying Languages"">RFC5646</a>]. |
| 622 |
|
| 623 |
"lang" : "mn-Cyrl-MN" |
| 624 |
|
| 625 |
Figure 10 |
| 626 |
|
| 627 |
The "lang" attribute may appear anywhere in an object class or data |
| 628 |
structure except for in jCard objects. |
| 629 |
|
| 630 |
<span class="h3"><a class="selflink" id="section-4.5" href="#section-4.5">4.5</a>. Events</span> |
| 631 |
|
| 632 |
This data structure represents events that have occurred on an |
| 633 |
instance of an object class (see <a href="#section-5">Section 5</a> regarding object classes). |
| 634 |
|
| 635 |
This is an example of an "events" array. |
| 636 |
|
| 637 |
"events" : |
| 638 |
[ |
| 639 |
{ |
| 640 |
"eventAction" : "registration", |
| 641 |
"eventActor" : "SOMEID-LUNARNIC", |
| 642 |
"eventDate" : "1990-12-31T23:59:59Z" |
| 643 |
}, |
| 644 |
{ |
| 645 |
"eventAction" : "last changed", |
| 646 |
"eventActor" : "OTHERID-LUNARNIC", |
| 647 |
"eventDate" : "1991-12-31T23:59:59Z" |
| 648 |
} |
| 649 |
] |
| 650 |
|
| 651 |
Figure 11 |
| 652 |
|
| 653 |
The "events" array consists of objects, each with the following |
| 654 |
members: |
| 655 |
|
| 656 |
o "eventAction" -- a string denoting the reason for the event |
| 657 |
|
| 658 |
o "eventActor" -- an optional identifier denoting the actor |
| 659 |
responsible for the event |
| 660 |
|
| 661 |
o "eventDate" -- a string containing the time and date the event |
| 662 |
occurred. |
| 663 |
|
| 664 |
o "links" -- see <a href="#section-4.2">Section 4.2</a> |
| 665 |
|
| 666 |
|
| 667 |
|
| 668 |
<span class="grey">Newton & Hollenbeck Standards Track [Page 12]</span></pre> |
| 669 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-13" ></span> |
| 670 |
<span class="grey"><a href="./rfc7483">RFC 7483</a> RDAP JSON Responses March 2015</span> |
| 671 |
|
| 672 |
|
| 673 |
Events can be future dated. One use case for future dating of events |
| 674 |
is to denote when an object expires from a registry. |
| 675 |
|
| 676 |
The "links" array in this data structure is provided for references |
| 677 |
to the event actor. In order to reference an RDAP entity, a "rel" of |
| 678 |
"related" and a "type" of "application/rdap+json" is used in the link |
| 679 |
reference. |
| 680 |
|
| 681 |
See <a href="#section-10.2.3">Section 10.2.3</a> for a list of values for the "eventAction" string. |
| 682 |
See <a href="#appendix-B">Appendix B</a> regarding the various ways events can be modeled. |
| 683 |
|
| 684 |
<span class="h3"><a class="selflink" id="section-4.6" href="#section-4.6">4.6</a>. Status</span> |
| 685 |
|
| 686 |
This data structure, named "status", is an array of strings |
| 687 |
indicating the state of a registered object (see <a href="#section-10.2.2">Section 10.2.2</a> for a |
| 688 |
list of values). |
| 689 |
|
| 690 |
<span class="h3"><a class="selflink" id="section-4.7" href="#section-4.7">4.7</a>. Port 43 WHOIS Server</span> |
| 691 |
|
| 692 |
This data structure, a member named "port43", is a simple string |
| 693 |
containing the fully qualified host name or IP address of the WHOIS |
| 694 |
[<a href="./rfc3912" title=""WHOIS Protocol Specification"">RFC3912</a>] server where the containing object instance may be found. |
| 695 |
Note that this is not a URI, as there is no WHOIS URI scheme. |
| 696 |
|
| 697 |
<span class="h3"><a class="selflink" id="section-4.8" href="#section-4.8">4.8</a>. Public IDs</span> |
| 698 |
|
| 699 |
This data structure maps a public identifier to an object class. It |
| 700 |
is named "publicIds" and is an array of objects, with each object |
| 701 |
containing the following members: |
| 702 |
|
| 703 |
o type -- a string denoting the type of public identifier |
| 704 |
|
| 705 |
o identifier -- a public identifier of the type denoted by "type" |
| 706 |
|
| 707 |
The following is an example of a publicIds structure. |
| 708 |
|
| 709 |
"publicIds": |
| 710 |
[ |
| 711 |
{ |
| 712 |
"type":"IANA Registrar ID", |
| 713 |
"identifier":"1" |
| 714 |
} |
| 715 |
] |
| 716 |
|
| 717 |
Figure 12 |
| 718 |
|
| 719 |
|
| 720 |
|
| 721 |
|
| 722 |
|
| 723 |
|
| 724 |
<span class="grey">Newton & Hollenbeck Standards Track [Page 13]</span></pre> |
| 725 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-14" ></span> |
| 726 |
<span class="grey"><a href="./rfc7483">RFC 7483</a> RDAP JSON Responses March 2015</span> |
| 727 |
|
| 728 |
|
| 729 |
<span class="h3"><a class="selflink" id="section-4.9" href="#section-4.9">4.9</a>. Object Class Name</span> |
| 730 |
|
| 731 |
This data structure, a member named "objectClassName", gives the |
| 732 |
object class name of a particular object as a string. This |
| 733 |
identifies the type of object being processed. An objectClassName is |
| 734 |
REQUIRED in all RDAP response objects so that the type of the object |
| 735 |
can be interpreted. |
| 736 |
|
| 737 |
<span class="h3"><a class="selflink" id="section-4.10" href="#section-4.10">4.10</a>. An Example</span> |
| 738 |
|
| 739 |
This is an example response with both rdapConformance and notices |
| 740 |
embedded: |
| 741 |
|
| 742 |
{ |
| 743 |
"rdapConformance" : |
| 744 |
[ |
| 745 |
"rdap_level_0" |
| 746 |
], |
| 747 |
"notices" : |
| 748 |
[ |
| 749 |
{ |
| 750 |
"title" : "Content Removed", |
| 751 |
"description" : |
| 752 |
[ |
| 753 |
"Without full authorization, content has been removed.", |
| 754 |
"Sorry, dude!" |
| 755 |
], |
| 756 |
"links" : |
| 757 |
[ |
| 758 |
{ |
| 759 |
"value" : "http://example.net/ip/192.0.2.0/24", |
| 760 |
"rel" : "alternate", |
| 761 |
"type" : "text/html", |
| 762 |
"href" : "http://www.example.com/redaction_policy.html" |
| 763 |
} |
| 764 |
] |
| 765 |
} |
| 766 |
], |
| 767 |
"lang" : "en", |
| 768 |
"objectClassName" : "ip network", |
| 769 |
"startAddress" : "192.0.2.0", |
| 770 |
"endAddress" : "192.0.2.255", |
| 771 |
"handle" : "XXXX-RIR", |
| 772 |
"ipVersion" : "v4", |
| 773 |
"name": "NET-RTR-1", |
| 774 |
"parentHandle" : "YYYY-RIR", |
| 775 |
"remarks" : |
| 776 |
[ |
| 777 |
|
| 778 |
|
| 779 |
|
| 780 |
<span class="grey">Newton & Hollenbeck Standards Track [Page 14]</span></pre> |
| 781 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-15" ></span> |
| 782 |
<span class="grey"><a href="./rfc7483">RFC 7483</a> RDAP JSON Responses March 2015</span> |
| 783 |
|
| 784 |
|
| 785 |
{ |
| 786 |
"description" : |
| 787 |
[ |
| 788 |
"She sells sea shells down by the sea shore.", |
| 789 |
"Originally written by Terry Sullivan." |
| 790 |
] |
| 791 |
} |
| 792 |
] |
| 793 |
} |
| 794 |
|
| 795 |
Figure 13 |
| 796 |
|
| 797 |
<span class="h2"><a class="selflink" id="section-5" href="#section-5">5</a>. Object Classes</span> |
| 798 |
|
| 799 |
Object classes represent structures appropriate for a response from |
| 800 |
the queries specified in [<a href="./rfc7482" title=""Registration Data Access Protocol (RDAP) Query Format"">RFC7482</a>]. |
| 801 |
|
| 802 |
Each object class contains a "links" array as specified in |
| 803 |
<a href="#section-4.2">Section 4.2</a>. For every object class instance in a response, whether |
| 804 |
the object class instance is directly representing the response to a |
| 805 |
query or is embedded in other object class instances or is an item in |
| 806 |
a search result set, servers SHOULD provide a link representing a URI |
| 807 |
for that object class instance using the "self" relationship as |
| 808 |
described in the IANA registry specified by [<a href="./rfc5988" title=""Web Linking"">RFC5988</a>]. As explained |
| 809 |
in <a href="#section-5.2">Section 5.2</a>, this may be not always be possible for nameserver |
| 810 |
data. Clients MUST be able to process object instances without a |
| 811 |
self link. When present, clients can use the self link for caching |
| 812 |
data. Servers MAY provide more than one self link for any given |
| 813 |
object instance. Failure to provide any self link by a server may |
| 814 |
result in clients being unable to cache object class instances. |
| 815 |
|
| 816 |
Clients using self links for caching SHOULD not cache any object |
| 817 |
class instances where the authority of the self link is different |
| 818 |
than the authority of the server returning the data. Failing to do |
| 819 |
so might result in cache poisoning. |
| 820 |
|
| 821 |
Self links MUST contain a "type" element containing the "application/ |
| 822 |
rdap+json" media type when referencing RDAP object instances as |
| 823 |
defined by this document. |
| 824 |
|
| 825 |
|
| 826 |
|
| 827 |
|
| 828 |
|
| 829 |
|
| 830 |
|
| 831 |
|
| 832 |
|
| 833 |
|
| 834 |
|
| 835 |
|
| 836 |
<span class="grey">Newton & Hollenbeck Standards Track [Page 15]</span></pre> |
| 837 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-16" ></span> |
| 838 |
<span class="grey"><a href="./rfc7483">RFC 7483</a> RDAP JSON Responses March 2015</span> |
| 839 |
|
| 840 |
|
| 841 |
This is an example of the "links" array with a self link to an object |
| 842 |
class: |
| 843 |
|
| 844 |
"links" : |
| 845 |
[ |
| 846 |
{ |
| 847 |
"value" : "http://example.com/ip/2001:db8::123", |
| 848 |
"rel" : "self", |
| 849 |
"href" : "http://example.com/ip/2001:db8::123", |
| 850 |
"type" : "application/rdap+json" |
| 851 |
} |
| 852 |
] |
| 853 |
|
| 854 |
Figure 14 |
| 855 |
|
| 856 |
<span class="h3"><a class="selflink" id="section-5.1" href="#section-5.1">5.1</a>. The Entity Object Class</span> |
| 857 |
|
| 858 |
The entity object class appears throughout this document and is an |
| 859 |
appropriate response for the /entity/XXXX query defined in |
| 860 |
"Registration Data Access Protocol (RDAP) Query Format" [<a href="./rfc7482" title=""Registration Data Access Protocol (RDAP) Query Format"">RFC7482</a>]. |
| 861 |
This object class represents the information of organizations, |
| 862 |
corporations, governments, non-profits, clubs, individual persons, |
| 863 |
and informal groups of people. All of these representations are so |
| 864 |
similar that it is best to represent them in JSON [<a href="./rfc7159" title=""The JavaScript Object Notation (JSON) Data Interchange Format"">RFC7159</a>] with one |
| 865 |
construct, the entity object class, to aid in the reuse of code by |
| 866 |
implementers. |
| 867 |
|
| 868 |
The entity object class uses jCard [<a href="./rfc7095" title=""jCard: The JSON Format for vCard"">RFC7095</a>] to represent contact |
| 869 |
information, such as postal addresses, email addresses, phone numbers |
| 870 |
and names of organizations and individuals. Many of the types of |
| 871 |
information that can be represented with jCard have no use in RDAP, |
| 872 |
such as birthdays, anniversaries, and gender. |
| 873 |
|
| 874 |
The entity object is served by both RIRs and DNRs. The following is |
| 875 |
an example of an entity that might be served by an RIR. |
| 876 |
|
| 877 |
{ |
| 878 |
"objectClassName" : "entity", |
| 879 |
"handle":"XXXX", |
| 880 |
"vcardArray":[ |
| 881 |
"vcard", |
| 882 |
[ |
| 883 |
["version", {}, "text", "4.0"], |
| 884 |
["fn", {}, "text", "Joe User"], |
| 885 |
["n", {}, "text", |
| 886 |
["User", "Joe", "", "", ["ing. jr", "M.Sc."]] |
| 887 |
], |
| 888 |
["kind", {}, "text", "individual"], |
| 889 |
|
| 890 |
|
| 891 |
|
| 892 |
<span class="grey">Newton & Hollenbeck Standards Track [Page 16]</span></pre> |
| 893 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-17" ></span> |
| 894 |
<span class="grey"><a href="./rfc7483">RFC 7483</a> RDAP JSON Responses March 2015</span> |
| 895 |
|
| 896 |
|
| 897 |
["lang", { |
| 898 |
"pref":"1" |
| 899 |
}, "language-tag", "fr"], |
| 900 |
["lang", { |
| 901 |
"pref":"2" |
| 902 |
}, "language-tag", "en"], |
| 903 |
["org", { |
| 904 |
"type":"work" |
| 905 |
}, "text", "Example"], |
| 906 |
["title", {}, "text", "Research Scientist"], |
| 907 |
["role", {}, "text", "Project Lead"], |
| 908 |
["adr", |
| 909 |
{ "type":"work" }, |
| 910 |
"text", |
| 911 |
[ |
| 912 |
"", |
| 913 |
"Suite 1234", |
| 914 |
"4321 Rue Somewhere", |
| 915 |
"Quebec", |
| 916 |
"QC", |
| 917 |
"G1V 2M2", |
| 918 |
"Canada" |
| 919 |
] |
| 920 |
], |
| 921 |
["adr", |
| 922 |
{ |
| 923 |
"type":"home", |
| 924 |
"label":"123 Maple Ave\nSuite 90001\nVancouver\nBC\n1239\n" |
| 925 |
}, |
| 926 |
"text", |
| 927 |
[ |
| 928 |
"", "", "", "", "", "", "" |
| 929 |
] |
| 930 |
], |
| 931 |
["tel", |
| 932 |
{ |
| 933 |
"type":["work", "voice"], |
| 934 |
"pref":"1" |
| 935 |
}, |
| 936 |
"uri", |
| 937 |
"tel:+1-555-555-1234;ext=102" |
| 938 |
], |
| 939 |
["tel", |
| 940 |
{ "type":["work", "cell", "voice", "video", "text"] }, |
| 941 |
"uri", |
| 942 |
"tel:+1-555-555-4321" |
| 943 |
], |
| 944 |
["email", |
| 945 |
|
| 946 |
|
| 947 |
|
| 948 |
<span class="grey">Newton & Hollenbeck Standards Track [Page 17]</span></pre> |
| 949 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-18" ></span> |
| 950 |
<span class="grey"><a href="./rfc7483">RFC 7483</a> RDAP JSON Responses March 2015</span> |
| 951 |
|
| 952 |
|
| 953 |
{ "type":"work" }, |
| 954 |
"text", |
| 955 |
"[email protected]" |
| 956 |
], |
| 957 |
["geo", { |
| 958 |
"type":"work" |
| 959 |
}, "uri", "geo:46.772673,-71.282945"], |
| 960 |
["key", |
| 961 |
{ "type":"work" }, |
| 962 |
"uri", |
| 963 |
"http://www.example.com/joe.user/joe.asc" |
| 964 |
], |
| 965 |
["tz", {}, |
| 966 |
"utc-offset", "-05:00"], |
| 967 |
["url", { "type":"home" }, |
| 968 |
"uri", "http://example.org"] |
| 969 |
] |
| 970 |
], |
| 971 |
"roles":[ "registrar" ], |
| 972 |
"publicIds":[ |
| 973 |
{ |
| 974 |
"type":"IANA Registrar ID", |
| 975 |
"identifier":"1" |
| 976 |
} |
| 977 |
], |
| 978 |
"remarks":[ |
| 979 |
{ |
| 980 |
"description":[ |
| 981 |
"She sells sea shells down by the sea shore.", |
| 982 |
"Originally written by Terry Sullivan." |
| 983 |
] |
| 984 |
} |
| 985 |
], |
| 986 |
"links":[ |
| 987 |
{ |
| 988 |
"value":"http://example.com/entity/XXXX", |
| 989 |
"rel":"self", |
| 990 |
"href":"http://example.com/entity/XXXX", |
| 991 |
"type" : "application/rdap+json" |
| 992 |
} |
| 993 |
], |
| 994 |
"events":[ |
| 995 |
{ |
| 996 |
"eventAction":"registration", |
| 997 |
"eventDate":"1990-12-31T23:59:59Z" |
| 998 |
} |
| 999 |
], |
| 1000 |
"asEventActor":[ |
| 1001 |
|
| 1002 |
|
| 1003 |
|
| 1004 |
<span class="grey">Newton & Hollenbeck Standards Track [Page 18]</span></pre> |
| 1005 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-19" ></span> |
| 1006 |
<span class="grey"><a href="./rfc7483">RFC 7483</a> RDAP JSON Responses March 2015</span> |
| 1007 |
|
| 1008 |
|
| 1009 |
{ |
| 1010 |
"eventAction":"last changed", |
| 1011 |
"eventDate":"1991-12-31T23:59:59Z" |
| 1012 |
} |
| 1013 |
] |
| 1014 |
} |
| 1015 |
|
| 1016 |
Figure 15 |
| 1017 |
|
| 1018 |
The entity object class can contain the following members: |
| 1019 |
|
| 1020 |
o objectClassName -- the string "entity" |
| 1021 |
|
| 1022 |
o handle -- a string representing a registry unique identifier of |
| 1023 |
the entity |
| 1024 |
|
| 1025 |
o vcardArray -- a jCard with the entity's contact information |
| 1026 |
|
| 1027 |
o roles -- an array of strings, each signifying the relationship an |
| 1028 |
object would have with its closest containing object (see |
| 1029 |
<a href="#section-10.2.4">Section 10.2.4</a> for a list of values) |
| 1030 |
|
| 1031 |
o publicIds -- see <a href="#section-4.8">Section 4.8</a> |
| 1032 |
|
| 1033 |
o entities -- an array of entity objects as defined by this section |
| 1034 |
|
| 1035 |
o remarks -- see <a href="#section-4.3">Section 4.3</a> |
| 1036 |
|
| 1037 |
o links -- see <a href="#section-4.2">Section 4.2</a> |
| 1038 |
|
| 1039 |
o events -- see <a href="#section-4.5">Section 4.5</a> |
| 1040 |
|
| 1041 |
o asEventActor -- this data structure takes the same form as the |
| 1042 |
events data structure (see <a href="#section-4.5">Section 4.5</a>), but each object in the |
| 1043 |
array MUST NOT have an "eventActor" member. These objects denote |
| 1044 |
that the entity is an event actor for the given events. See |
| 1045 |
<a href="#appendix-B">Appendix B</a> regarding the various ways events can be modeled. |
| 1046 |
|
| 1047 |
o status -- see <a href="#section-4.6">Section 4.6</a> |
| 1048 |
|
| 1049 |
o port43 -- see <a href="#section-4.7">Section 4.7</a> |
| 1050 |
|
| 1051 |
o networks -- an array of IP network objects as defined in |
| 1052 |
<a href="#section-5.4">Section 5.4</a> |
| 1053 |
|
| 1054 |
o autnums -- an array of autnum objects as defined in <a href="#section-5.5">Section 5.5</a> |
| 1055 |
|
| 1056 |
|
| 1057 |
|
| 1058 |
|
| 1059 |
|
| 1060 |
<span class="grey">Newton & Hollenbeck Standards Track [Page 19]</span></pre> |
| 1061 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-20" ></span> |
| 1062 |
<span class="grey"><a href="./rfc7483">RFC 7483</a> RDAP JSON Responses March 2015</span> |
| 1063 |
|
| 1064 |
|
| 1065 |
Entities may also have other entities embedded with them in an array. |
| 1066 |
This can be used to model an organization with specific individuals |
| 1067 |
fulfilling designated roles of responsibility. |
| 1068 |
|
| 1069 |
The following is an elided example of an entity with embedded |
| 1070 |
entities. |
| 1071 |
|
| 1072 |
{ |
| 1073 |
"objectClassName" : "entity", |
| 1074 |
"handle" : "ANENTITY", |
| 1075 |
"roles" : [ "registrar" ], |
| 1076 |
... |
| 1077 |
"entities" : |
| 1078 |
[ |
| 1079 |
{ |
| 1080 |
"objectClassName" : "entity", |
| 1081 |
"handle": "ANEMBEDDEDENTITY", |
| 1082 |
"roles" : [ "technical" ], |
| 1083 |
... |
| 1084 |
}, |
| 1085 |
... |
| 1086 |
], |
| 1087 |
... |
| 1088 |
} |
| 1089 |
|
| 1090 |
Figure 16 |
| 1091 |
|
| 1092 |
The following is an example of an entity that might be served by a |
| 1093 |
DNR. |
| 1094 |
|
| 1095 |
{ |
| 1096 |
"objectClassName" : "entity", |
| 1097 |
"handle":"XXXX", |
| 1098 |
"vcardArray":[ |
| 1099 |
"vcard", |
| 1100 |
[ |
| 1101 |
["version", {}, "text", "4.0"], |
| 1102 |
["fn", {}, "text", "Joe User"], |
| 1103 |
["kind", {}, "text", "individual"], |
| 1104 |
["lang", { |
| 1105 |
"pref":"1" |
| 1106 |
}, "language-tag", "fr"], |
| 1107 |
["lang", { |
| 1108 |
"pref":"2" |
| 1109 |
}, "language-tag", "en"], |
| 1110 |
["org", { |
| 1111 |
"type":"work" |
| 1112 |
}, "text", "Example"], |
| 1113 |
|
| 1114 |
|
| 1115 |
|
| 1116 |
<span class="grey">Newton & Hollenbeck Standards Track [Page 20]</span></pre> |
| 1117 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-21" ></span> |
| 1118 |
<span class="grey"><a href="./rfc7483">RFC 7483</a> RDAP JSON Responses March 2015</span> |
| 1119 |
|
| 1120 |
|
| 1121 |
["title", {}, "text", "Research Scientist"], |
| 1122 |
["role", {}, "text", "Project Lead"], |
| 1123 |
["adr", |
| 1124 |
{ "type":"work" }, |
| 1125 |
"text", |
| 1126 |
[ |
| 1127 |
"", |
| 1128 |
"Suite 1234", |
| 1129 |
"4321 Rue Somewhere", |
| 1130 |
"Quebec", |
| 1131 |
"QC", |
| 1132 |
"G1V 2M2", |
| 1133 |
"Canada" |
| 1134 |
] |
| 1135 |
], |
| 1136 |
["tel", |
| 1137 |
{ "type":["work", "voice"], "pref":"1" }, |
| 1138 |
"uri", "tel:+1-555-555-1234;ext=102" |
| 1139 |
], |
| 1140 |
["email", |
| 1141 |
{ "type":"work" }, |
| 1142 |
"text", "[email protected]" |
| 1143 |
] |
| 1144 |
] |
| 1145 |
], |
| 1146 |
"status":[ "validated", "locked" ], |
| 1147 |
"remarks":[ |
| 1148 |
{ |
| 1149 |
"description":[ |
| 1150 |
"She sells sea shells down by the sea shore.", |
| 1151 |
"Originally written by Terry Sullivan." |
| 1152 |
] |
| 1153 |
} |
| 1154 |
], |
| 1155 |
"links":[ |
| 1156 |
{ |
| 1157 |
"value":"http://example.com/entity/XXXX", |
| 1158 |
"rel":"self", |
| 1159 |
"href":"http://example.com/entity/XXXX", |
| 1160 |
"type":"application/rdap+json" |
| 1161 |
} |
| 1162 |
], |
| 1163 |
"port43":"whois.example.net", |
| 1164 |
"events":[ |
| 1165 |
{ |
| 1166 |
"eventAction":"registration", |
| 1167 |
"eventDate":"1990-12-31T23:59:59Z" |
| 1168 |
}, |
| 1169 |
|
| 1170 |
|
| 1171 |
|
| 1172 |
<span class="grey">Newton & Hollenbeck Standards Track [Page 21]</span></pre> |
| 1173 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-22" ></span> |
| 1174 |
<span class="grey"><a href="./rfc7483">RFC 7483</a> RDAP JSON Responses March 2015</span> |
| 1175 |
|
| 1176 |
|
| 1177 |
{ |
| 1178 |
"eventAction":"last changed", |
| 1179 |
"eventDate":"1991-12-31T23:59:59Z", |
| 1180 |
"eventActor":"[email protected]" |
| 1181 |
} |
| 1182 |
] |
| 1183 |
} |
| 1184 |
|
| 1185 |
Figure 17 |
| 1186 |
|
| 1187 |
See <a href="#appendix-A">Appendix A</a> for use of the entity object class to model various |
| 1188 |
types of entities found in both RIRs and DNRs. See <a href="#appendix-C">Appendix C</a> |
| 1189 |
regarding structured vs. unstructured postal addresses in entities. |
| 1190 |
|
| 1191 |
<span class="h3"><a class="selflink" id="section-5.2" href="#section-5.2">5.2</a>. The Nameserver Object Class</span> |
| 1192 |
|
| 1193 |
The nameserver object class represents information regarding DNS |
| 1194 |
nameservers used in both forward and reverse DNS. RIRs and some DNRs |
| 1195 |
register or expose nameserver information as an attribute of a domain |
| 1196 |
name, while other DNRs model nameservers as "first class objects". |
| 1197 |
|
| 1198 |
The nameserver object class accommodates both models and degrees of |
| 1199 |
variation in between. |
| 1200 |
|
| 1201 |
The following is an example of a nameserver object. |
| 1202 |
|
| 1203 |
|
| 1204 |
|
| 1205 |
|
| 1206 |
|
| 1207 |
|
| 1208 |
|
| 1209 |
|
| 1210 |
|
| 1211 |
|
| 1212 |
|
| 1213 |
|
| 1214 |
|
| 1215 |
|
| 1216 |
|
| 1217 |
|
| 1218 |
|
| 1219 |
|
| 1220 |
|
| 1221 |
|
| 1222 |
|
| 1223 |
|
| 1224 |
|
| 1225 |
|
| 1226 |
|
| 1227 |
|
| 1228 |
<span class="grey">Newton & Hollenbeck Standards Track [Page 22]</span></pre> |
| 1229 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-23" ></span> |
| 1230 |
<span class="grey"><a href="./rfc7483">RFC 7483</a> RDAP JSON Responses March 2015</span> |
| 1231 |
|
| 1232 |
|
| 1233 |
{ |
| 1234 |
"objectClassName" : "nameserver", |
| 1235 |
"handle" : "XXXX", |
| 1236 |
"ldhName" : "ns1.xn--fo-5ja.example", |
| 1237 |
"unicodeName" : "ns1.foo.example", |
| 1238 |
"status" : [ "active" ], |
| 1239 |
"ipAddresses" : |
| 1240 |
{ |
| 1241 |
"v4": [ "192.0.2.1", "192.0.2.2" ], |
| 1242 |
"v6": [ "2001:db8::123" ] |
| 1243 |
}, |
| 1244 |
"remarks" : |
| 1245 |
[ |
| 1246 |
{ |
| 1247 |
"description" : |
| 1248 |
[ |
| 1249 |
"She sells sea shells down by the sea shore.", |
| 1250 |
"Originally written by Terry Sullivan." |
| 1251 |
] |
| 1252 |
} |
| 1253 |
], |
| 1254 |
"links" : |
| 1255 |
[ |
| 1256 |
{ |
| 1257 |
"value" : "http://example.net/nameserver/xxxx", |
| 1258 |
"rel" : "self", |
| 1259 |
"href" : "http://example.net/nameserver/xxxx", |
| 1260 |
"type" : "application/rdap+json" |
| 1261 |
} |
| 1262 |
], |
| 1263 |
"port43" : "whois.example.net", |
| 1264 |
"events" : |
| 1265 |
[ |
| 1266 |
{ |
| 1267 |
"eventAction" : "registration", |
| 1268 |
"eventDate" : "1990-12-31T23:59:59Z" |
| 1269 |
}, |
| 1270 |
{ |
| 1271 |
"eventAction" : "last changed", |
| 1272 |
"eventDate" : "1991-12-31T23:59:59Z", |
| 1273 |
"eventActor" : "[email protected]" |
| 1274 |
} |
| 1275 |
] |
| 1276 |
} |
| 1277 |
|
| 1278 |
|
| 1279 |
Figure 18 |
| 1280 |
|
| 1281 |
|
| 1282 |
|
| 1283 |
|
| 1284 |
<span class="grey">Newton & Hollenbeck Standards Track [Page 23]</span></pre> |
| 1285 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-24" ></span> |
| 1286 |
<span class="grey"><a href="./rfc7483">RFC 7483</a> RDAP JSON Responses March 2015</span> |
| 1287 |
|
| 1288 |
|
| 1289 |
Figure 18 is an example of a nameserver object with all values given. |
| 1290 |
Registries using a first-class nameserver data model would embed this |
| 1291 |
in domain objects as well as allowing references to it with the |
| 1292 |
"/nameserver" query type (all depending on the registry operators |
| 1293 |
policy). Other registries may pare back the information as needed. |
| 1294 |
Figure 19 is an example of a nameserver object as would be found in |
| 1295 |
RIRs and some DNRs, while Figure 20 is an example of a nameserver |
| 1296 |
object as would be found in other DNRs. |
| 1297 |
|
| 1298 |
The following is an example of the simplest nameserver object: |
| 1299 |
|
| 1300 |
{ |
| 1301 |
"objectClassName" : "nameserver", |
| 1302 |
"ldhName" : "ns1.example.com" |
| 1303 |
} |
| 1304 |
|
| 1305 |
Figure 19 |
| 1306 |
|
| 1307 |
The following is an example of a simple nameserver object that might |
| 1308 |
be commonly used by DNRs: |
| 1309 |
|
| 1310 |
{ |
| 1311 |
"objectClassName" : "nameserver", |
| 1312 |
"ldhName" : "ns1.example.com", |
| 1313 |
"ipAddresses" : { "v6" : [ "2001:db8::123", "2001:db8::124" ] } |
| 1314 |
} |
| 1315 |
|
| 1316 |
Figure 20 |
| 1317 |
|
| 1318 |
As nameservers can be modeled by some registries to be first-class |
| 1319 |
objects, they may also have an array of entities (<a href="#section-5.1">Section 5.1</a>) |
| 1320 |
embedded to signify parties responsible for the maintenance, |
| 1321 |
registrations, etc., of the nameservers. |
| 1322 |
|
| 1323 |
The following is an elided example of a nameserver with embedded |
| 1324 |
entities. |
| 1325 |
|
| 1326 |
|
| 1327 |
|
| 1328 |
|
| 1329 |
|
| 1330 |
|
| 1331 |
|
| 1332 |
|
| 1333 |
|
| 1334 |
|
| 1335 |
|
| 1336 |
|
| 1337 |
|
| 1338 |
|
| 1339 |
|
| 1340 |
<span class="grey">Newton & Hollenbeck Standards Track [Page 24]</span></pre> |
| 1341 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-25" ></span> |
| 1342 |
<span class="grey"><a href="./rfc7483">RFC 7483</a> RDAP JSON Responses March 2015</span> |
| 1343 |
|
| 1344 |
|
| 1345 |
{ |
| 1346 |
"objectClassName" : "nameserver", |
| 1347 |
"handle" : "XXXX", |
| 1348 |
"ldhName" : "ns1.xn--fo-5ja.example", |
| 1349 |
... |
| 1350 |
"entities" : |
| 1351 |
[ |
| 1352 |
... |
| 1353 |
], |
| 1354 |
... |
| 1355 |
} |
| 1356 |
|
| 1357 |
Figure 21 |
| 1358 |
|
| 1359 |
The nameserver object class can contain the following members: |
| 1360 |
|
| 1361 |
o objectClassName -- the string "nameserver" |
| 1362 |
|
| 1363 |
o handle -- a string representing a registry unique identifier of |
| 1364 |
the nameserver |
| 1365 |
|
| 1366 |
o ldhName -- a string containing the LDH name of the nameserver (see |
| 1367 |
<a href="#section-3">Section 3</a>) |
| 1368 |
|
| 1369 |
o unicodeName -- a string containing a DNS Unicode name of the |
| 1370 |
nameserver (see <a href="#section-3">Section 3</a>) |
| 1371 |
|
| 1372 |
o ipAddresses -- an object containing the following members: |
| 1373 |
|
| 1374 |
* v6 -- an array of strings containing IPv6 addresses of the |
| 1375 |
nameserver |
| 1376 |
|
| 1377 |
* v4 -- an array of strings containing IPv4 addresses of the |
| 1378 |
nameserver |
| 1379 |
|
| 1380 |
o entities -- an array of entity objects as defined by <a href="#section-5.1">Section 5.1</a> |
| 1381 |
|
| 1382 |
o status -- see <a href="#section-4.6">Section 4.6</a> |
| 1383 |
|
| 1384 |
o remarks -- see <a href="#section-4.3">Section 4.3</a> |
| 1385 |
|
| 1386 |
o links -- see <a href="#section-4.2">Section 4.2</a> |
| 1387 |
|
| 1388 |
o port43 -- see <a href="#section-4.7">Section 4.7</a> |
| 1389 |
|
| 1390 |
o events -- see <a href="#section-4.5">Section 4.5</a> |
| 1391 |
|
| 1392 |
|
| 1393 |
|
| 1394 |
|
| 1395 |
|
| 1396 |
<span class="grey">Newton & Hollenbeck Standards Track [Page 25]</span></pre> |
| 1397 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-26" ></span> |
| 1398 |
<span class="grey"><a href="./rfc7483">RFC 7483</a> RDAP JSON Responses March 2015</span> |
| 1399 |
|
| 1400 |
|
| 1401 |
<span class="h3"><a class="selflink" id="section-5.3" href="#section-5.3">5.3</a>. The Domain Object Class</span> |
| 1402 |
|
| 1403 |
The domain object class represents a DNS name and point of |
| 1404 |
delegation. For RIRs, these delegation points are in the reverse DNS |
| 1405 |
tree, whereas for DNRs, these delegation points are in the forward |
| 1406 |
DNS tree. |
| 1407 |
|
| 1408 |
In both cases, the high-level structure of the domain object class |
| 1409 |
consists of information about the domain registration, nameserver |
| 1410 |
information related to the domain name, and entities related to the |
| 1411 |
domain name (e.g., registrant information, contacts, etc.). |
| 1412 |
|
| 1413 |
The following is an elided example of the domain object showing the |
| 1414 |
high-level structure: |
| 1415 |
|
| 1416 |
{ |
| 1417 |
"objectClassName" : "domain", |
| 1418 |
"handle" : "XXX", |
| 1419 |
"ldhName" : "blah.example.com", |
| 1420 |
... |
| 1421 |
"nameservers" : |
| 1422 |
[ |
| 1423 |
... |
| 1424 |
], |
| 1425 |
... |
| 1426 |
"entities" : |
| 1427 |
[ |
| 1428 |
... |
| 1429 |
] |
| 1430 |
} |
| 1431 |
|
| 1432 |
Figure 22 |
| 1433 |
|
| 1434 |
The domain object class can contain the following members: |
| 1435 |
|
| 1436 |
o objectClassName -- the string "domain" |
| 1437 |
|
| 1438 |
o handle -- a string representing a registry unique identifier of |
| 1439 |
the domain object instance |
| 1440 |
|
| 1441 |
o ldhName -- a string describing a domain name in LDH form as |
| 1442 |
described in <a href="#section-3">Section 3</a> |
| 1443 |
|
| 1444 |
o unicodeName -- a string containing a domain name with U-labels as |
| 1445 |
described in <a href="#section-3">Section 3</a> |
| 1446 |
|
| 1447 |
|
| 1448 |
|
| 1449 |
|
| 1450 |
|
| 1451 |
|
| 1452 |
<span class="grey">Newton & Hollenbeck Standards Track [Page 26]</span></pre> |
| 1453 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-27" ></span> |
| 1454 |
<span class="grey"><a href="./rfc7483">RFC 7483</a> RDAP JSON Responses March 2015</span> |
| 1455 |
|
| 1456 |
|
| 1457 |
o variants -- an array of objects, each containing the following |
| 1458 |
values: |
| 1459 |
|
| 1460 |
* relation -- an array of strings, with each string denoting the |
| 1461 |
relationship between the variants and the containing domain |
| 1462 |
object (see <a href="#section-10.2.5">Section 10.2.5</a> for a list of suggested variant |
| 1463 |
relations). |
| 1464 |
|
| 1465 |
* idnTable -- the name of the Internationalized Domain Name (IDN) |
| 1466 |
table of codepoints, such as one listed with the IANA (see IDN |
| 1467 |
tables [<a href="#ref-IANA_IDNTABLES">IANA_IDNTABLES</a>]). |
| 1468 |
|
| 1469 |
* variantNames -- an array of objects, with each object |
| 1470 |
containing an "ldhName" member and a "unicodeName" member (see |
| 1471 |
<a href="#section-3">Section 3</a>). |
| 1472 |
|
| 1473 |
o nameservers -- an array of nameserver objects as defined by |
| 1474 |
<a href="#section-5.2">Section 5.2</a> |
| 1475 |
|
| 1476 |
o secureDNS -- an object with the following members: |
| 1477 |
|
| 1478 |
* zoneSigned -- true if the zone has been signed, false |
| 1479 |
otherwise. |
| 1480 |
|
| 1481 |
* delegationSigned -- boolean true if there are DS records in the |
| 1482 |
parent, false otherwise. |
| 1483 |
|
| 1484 |
* maxSigLife -- an integer representing the signature lifetime in |
| 1485 |
seconds to be used when creating the RRSIG DS record in the |
| 1486 |
parent zone [<a href="./rfc5910" title=""Domain Name System (DNS) Security Extensions Mapping for the Extensible Provisioning Protocol (EPP)"">RFC5910</a>]. |
| 1487 |
|
| 1488 |
* dsData -- an array of objects, each with the following members: |
| 1489 |
|
| 1490 |
+ keyTag -- an integer as specified by the key tag field of a |
| 1491 |
DNS DS record as specified by [<a href="./rfc4034" title=""Resource Records for the DNS Security Extensions"">RFC4034</a>] in presentation |
| 1492 |
format |
| 1493 |
|
| 1494 |
+ algorithm -- an integer as specified by the algorithm field |
| 1495 |
of a DNS DS record as described by <a href="./rfc4034">RFC 4034</a> in presentation |
| 1496 |
format |
| 1497 |
|
| 1498 |
+ digest -- a string as specified by the digest field of a DNS |
| 1499 |
DS record as specified by <a href="./rfc4034">RFC 4034</a> in presentation format |
| 1500 |
|
| 1501 |
+ digestType -- an integer as specified by the digest type |
| 1502 |
field of a DNS DS record as specified by <a href="./rfc4034">RFC 4034</a> in |
| 1503 |
presentation format |
| 1504 |
|
| 1505 |
|
| 1506 |
|
| 1507 |
|
| 1508 |
<span class="grey">Newton & Hollenbeck Standards Track [Page 27]</span></pre> |
| 1509 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-28" ></span> |
| 1510 |
<span class="grey"><a href="./rfc7483">RFC 7483</a> RDAP JSON Responses March 2015</span> |
| 1511 |
|
| 1512 |
|
| 1513 |
+ events -- see <a href="#section-4.5">Section 4.5</a> |
| 1514 |
|
| 1515 |
+ links -- see <a href="#section-4.2">Section 4.2</a> |
| 1516 |
|
| 1517 |
* keyData -- an array of objects, each with the following |
| 1518 |
members: |
| 1519 |
|
| 1520 |
+ flags -- an integer representing the flags field value in |
| 1521 |
the DNSKEY record [<a href="./rfc4034" title=""Resource Records for the DNS Security Extensions"">RFC4034</a>] in presentation format |
| 1522 |
|
| 1523 |
+ protocol -- an integer representation of the protocol field |
| 1524 |
value of the DNSKEY record [<a href="./rfc4034" title=""Resource Records for the DNS Security Extensions"">RFC4034</a>] in presentation format |
| 1525 |
|
| 1526 |
+ publicKey -- a string representation of the public key in |
| 1527 |
the DNSKEY record [<a href="./rfc4034" title=""Resource Records for the DNS Security Extensions"">RFC4034</a>] in presentation format |
| 1528 |
|
| 1529 |
+ algorithm -- an integer as specified by the algorithm field |
| 1530 |
of a DNSKEY record as specified by [<a href="./rfc4034" title=""Resource Records for the DNS Security Extensions"">RFC4034</a>] in presentation |
| 1531 |
format |
| 1532 |
|
| 1533 |
+ events -- see <a href="#section-4.5">Section 4.5</a> |
| 1534 |
|
| 1535 |
+ links -- see <a href="#section-4.2">Section 4.2</a> |
| 1536 |
|
| 1537 |
See <a href="#appendix-D">Appendix D</a> for background information on these objects. |
| 1538 |
|
| 1539 |
o entities -- an array of entity objects as defined by <a href="#section-5.1">Section 5.1</a> |
| 1540 |
|
| 1541 |
o status -- see <a href="#section-4.6">Section 4.6</a> |
| 1542 |
|
| 1543 |
o publicIds -- see <a href="#section-4.8">Section 4.8</a> |
| 1544 |
|
| 1545 |
o remarks -- see <a href="#section-4.3">Section 4.3</a> |
| 1546 |
|
| 1547 |
o links -- see <a href="#section-4.2">Section 4.2</a> |
| 1548 |
|
| 1549 |
o port43 -- see <a href="#section-4.7">Section 4.7</a> |
| 1550 |
|
| 1551 |
o events -- see <a href="#section-4.5">Section 4.5</a> |
| 1552 |
|
| 1553 |
o network -- represents the IP network for which a reverse DNS |
| 1554 |
domain is referenced. See <a href="#section-5.4">Section 5.4</a> |
| 1555 |
|
| 1556 |
|
| 1557 |
|
| 1558 |
|
| 1559 |
|
| 1560 |
|
| 1561 |
|
| 1562 |
|
| 1563 |
|
| 1564 |
<span class="grey">Newton & Hollenbeck Standards Track [Page 28]</span></pre> |
| 1565 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-29" ></span> |
| 1566 |
<span class="grey"><a href="./rfc7483">RFC 7483</a> RDAP JSON Responses March 2015</span> |
| 1567 |
|
| 1568 |
|
| 1569 |
The following is an example of a JSON domain object representing a |
| 1570 |
reverse DNS delegation point that might be served by an RIR. |
| 1571 |
|
| 1572 |
{ |
| 1573 |
"objectClassName" : "domain", |
| 1574 |
"handle" : "XXXX", |
| 1575 |
"ldhName" : "0.2.192.in-addr.arpa", |
| 1576 |
"nameservers" : |
| 1577 |
[ |
| 1578 |
{ |
| 1579 |
"objectClassName" : "nameserver", |
| 1580 |
"ldhName" : "ns1.rir.example" |
| 1581 |
}, |
| 1582 |
{ |
| 1583 |
"objectClassName" : "nameserver", |
| 1584 |
"ldhName" : "ns2.rir.example" |
| 1585 |
} |
| 1586 |
], |
| 1587 |
"secureDNS": |
| 1588 |
{ |
| 1589 |
"delegationSigned": true, |
| 1590 |
"dsData": |
| 1591 |
[ |
| 1592 |
{ |
| 1593 |
"keyTag": 12345, |
| 1594 |
"algorithm": 3, |
| 1595 |
"digestType": 1, |
| 1596 |
"digest": "49FD46E6C4B45C55D4AC" |
| 1597 |
} |
| 1598 |
] |
| 1599 |
}, |
| 1600 |
"remarks" : |
| 1601 |
[ |
| 1602 |
{ |
| 1603 |
"description" : |
| 1604 |
[ |
| 1605 |
"She sells sea shells down by the sea shore.", |
| 1606 |
"Originally written by Terry Sullivan." |
| 1607 |
] |
| 1608 |
} |
| 1609 |
], |
| 1610 |
"links" : |
| 1611 |
[ |
| 1612 |
{ |
| 1613 |
"value": "http://example.net/domain/XXXX", |
| 1614 |
"rel" : "self", |
| 1615 |
"href" : "http://example.net/domain/XXXXX", |
| 1616 |
"type" : "application/rdap+json" |
| 1617 |
|
| 1618 |
|
| 1619 |
|
| 1620 |
<span class="grey">Newton & Hollenbeck Standards Track [Page 29]</span></pre> |
| 1621 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-30" ></span> |
| 1622 |
<span class="grey"><a href="./rfc7483">RFC 7483</a> RDAP JSON Responses March 2015</span> |
| 1623 |
|
| 1624 |
|
| 1625 |
} |
| 1626 |
], |
| 1627 |
"events" : |
| 1628 |
[ |
| 1629 |
{ |
| 1630 |
"eventAction" : "registration", |
| 1631 |
"eventDate" : "1990-12-31T23:59:59Z" |
| 1632 |
}, |
| 1633 |
{ |
| 1634 |
"eventAction" : "last changed", |
| 1635 |
"eventDate" : "1991-12-31T23:59:59Z", |
| 1636 |
"eventActor" : "[email protected]" |
| 1637 |
} |
| 1638 |
], |
| 1639 |
"entities" : |
| 1640 |
[ |
| 1641 |
{ |
| 1642 |
"objectClassName" : "entity", |
| 1643 |
"handle" : "XXXX", |
| 1644 |
"vcardArray":[ |
| 1645 |
"vcard", |
| 1646 |
[ |
| 1647 |
["version", {}, "text", "4.0"], |
| 1648 |
["fn", {}, "text", "Joe User"], |
| 1649 |
["kind", {}, "text", "individual"], |
| 1650 |
["lang", { |
| 1651 |
"pref":"1" |
| 1652 |
}, "language-tag", "fr"], |
| 1653 |
["lang", { |
| 1654 |
"pref":"2" |
| 1655 |
}, "language-tag", "en"], |
| 1656 |
["org", { |
| 1657 |
"type":"work" |
| 1658 |
}, "text", "Example"], |
| 1659 |
["title", {}, "text", "Research Scientist"], |
| 1660 |
["role", {}, "text", "Project Lead"], |
| 1661 |
["adr", |
| 1662 |
{ "type":"work" }, |
| 1663 |
"text", |
| 1664 |
[ |
| 1665 |
"", |
| 1666 |
"Suite 1234", |
| 1667 |
"4321 Rue Somewhere", |
| 1668 |
"Quebec", |
| 1669 |
"QC", |
| 1670 |
"G1V 2M2", |
| 1671 |
"Canada" |
| 1672 |
] |
| 1673 |
|
| 1674 |
|
| 1675 |
|
| 1676 |
<span class="grey">Newton & Hollenbeck Standards Track [Page 30]</span></pre> |
| 1677 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-31" ></span> |
| 1678 |
<span class="grey"><a href="./rfc7483">RFC 7483</a> RDAP JSON Responses March 2015</span> |
| 1679 |
|
| 1680 |
|
| 1681 |
], |
| 1682 |
["tel", |
| 1683 |
{ "type":["work", "voice"], "pref":"1" }, |
| 1684 |
"uri", "tel:+1-555-555-1234;ext=102" |
| 1685 |
], |
| 1686 |
["email", |
| 1687 |
{ "type":"work" }, |
| 1688 |
"text", "[email protected]" |
| 1689 |
] |
| 1690 |
] |
| 1691 |
], |
| 1692 |
"roles" : [ "registrant" ], |
| 1693 |
"remarks" : |
| 1694 |
[ |
| 1695 |
{ |
| 1696 |
"description" : |
| 1697 |
[ |
| 1698 |
"She sells sea shells down by the sea shore.", |
| 1699 |
"Originally written by Terry Sullivan." |
| 1700 |
] |
| 1701 |
} |
| 1702 |
], |
| 1703 |
"links" : |
| 1704 |
[ |
| 1705 |
{ |
| 1706 |
"value": "http://example.net/entity/xxxx", |
| 1707 |
"rel" : "self", |
| 1708 |
"href" : "http://example.net/entity/xxxx", |
| 1709 |
"type" : "application/rdap+json" |
| 1710 |
} |
| 1711 |
], |
| 1712 |
"events" : |
| 1713 |
[ |
| 1714 |
{ |
| 1715 |
"eventAction" : "registration", |
| 1716 |
"eventDate" : "1990-12-31T23:59:59Z" |
| 1717 |
}, |
| 1718 |
{ |
| 1719 |
"eventAction" : "last changed", |
| 1720 |
"eventDate" : "1991-12-31T23:59:59Z", |
| 1721 |
"eventActor" : "[email protected]" |
| 1722 |
} |
| 1723 |
] |
| 1724 |
} |
| 1725 |
], |
| 1726 |
"network" : |
| 1727 |
{ |
| 1728 |
"objectClassName" : "ip network", |
| 1729 |
|
| 1730 |
|
| 1731 |
|
| 1732 |
<span class="grey">Newton & Hollenbeck Standards Track [Page 31]</span></pre> |
| 1733 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-32" ></span> |
| 1734 |
<span class="grey"><a href="./rfc7483">RFC 7483</a> RDAP JSON Responses March 2015</span> |
| 1735 |
|
| 1736 |
|
| 1737 |
"handle" : "XXXX-RIR", |
| 1738 |
"startAddress" : "192.0.2.0", |
| 1739 |
"endAddress" : "192.0.2.255", |
| 1740 |
"ipVersion" : "v6", |
| 1741 |
"name": "NET-RTR-1", |
| 1742 |
"type" : "DIRECT ALLOCATION", |
| 1743 |
"country" : "AU", |
| 1744 |
"parentHandle" : "YYYY-RIR", |
| 1745 |
"status" : [ "active" ] |
| 1746 |
} |
| 1747 |
} |
| 1748 |
|
| 1749 |
Figure 23 |
| 1750 |
|
| 1751 |
The following is an example of a JSON domain object representing a |
| 1752 |
forward DNS delegation point that might be served by a DNR. |
| 1753 |
|
| 1754 |
{ |
| 1755 |
"objectClassName" : "domain", |
| 1756 |
"handle" : "XXXX", |
| 1757 |
"ldhName" : "xn--fo-5ja.example", |
| 1758 |
"unicodeName" : "foo.example", |
| 1759 |
"variants" : |
| 1760 |
[ |
| 1761 |
{ |
| 1762 |
"relation" : [ "registered", "conjoined" ], |
| 1763 |
"variantNames" : |
| 1764 |
[ |
| 1765 |
{ |
| 1766 |
"ldhName" : "xn--fo-cka.example", |
| 1767 |
"unicodeName" : "foo.example" |
| 1768 |
}, |
| 1769 |
{ |
| 1770 |
"ldhName" : "xn--fo-fka.example", |
| 1771 |
"unicodeName" : "foo.example" |
| 1772 |
} |
| 1773 |
] |
| 1774 |
}, |
| 1775 |
{ |
| 1776 |
"relation" : [ "unregistered", "registration restricted" ], |
| 1777 |
"idnTable": ".EXAMPLE Swedish", |
| 1778 |
"variantNames" : |
| 1779 |
[ |
| 1780 |
{ |
| 1781 |
"ldhName": "xn--fo-8ja.example", |
| 1782 |
"unicodeName" : "foo.example" |
| 1783 |
} |
| 1784 |
] |
| 1785 |
|
| 1786 |
|
| 1787 |
|
| 1788 |
<span class="grey">Newton & Hollenbeck Standards Track [Page 32]</span></pre> |
| 1789 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-33" ></span> |
| 1790 |
<span class="grey"><a href="./rfc7483">RFC 7483</a> RDAP JSON Responses March 2015</span> |
| 1791 |
|
| 1792 |
|
| 1793 |
} |
| 1794 |
], |
| 1795 |
"status" : [ "locked", "transfer prohibited" ], |
| 1796 |
"publicIds":[ |
| 1797 |
{ |
| 1798 |
"type":"ENS_Auth ID", |
| 1799 |
"identifier":"1234567890" |
| 1800 |
} |
| 1801 |
], |
| 1802 |
"nameservers" : |
| 1803 |
[ |
| 1804 |
{ |
| 1805 |
"objectClassName" : "nameserver", |
| 1806 |
"handle" : "XXXX", |
| 1807 |
"ldhName" : "ns1.example.com", |
| 1808 |
"status" : [ "active" ], |
| 1809 |
"ipAddresses" : |
| 1810 |
{ |
| 1811 |
"v6": [ "2001:db8::123", "2001:db8::124" ], |
| 1812 |
"v4": [ "192.0.2.1", "192.0.2.2" ] |
| 1813 |
}, |
| 1814 |
"remarks" : |
| 1815 |
[ |
| 1816 |
{ |
| 1817 |
"description" : |
| 1818 |
[ |
| 1819 |
"She sells sea shells down by the sea shore.", |
| 1820 |
"Originally written by Terry Sullivan." |
| 1821 |
] |
| 1822 |
} |
| 1823 |
], |
| 1824 |
"links" : |
| 1825 |
[ |
| 1826 |
{ |
| 1827 |
"value" : "http://example.net/nameserver/XXXX", |
| 1828 |
"rel" : "self", |
| 1829 |
"href" : "http://example.net/nameserver/XXXX", |
| 1830 |
"type" : "application/rdap+json" |
| 1831 |
} |
| 1832 |
], |
| 1833 |
"events" : |
| 1834 |
[ |
| 1835 |
{ |
| 1836 |
"eventAction" : "registration", |
| 1837 |
"eventDate" : "1990-12-31T23:59:59Z" |
| 1838 |
}, |
| 1839 |
{ |
| 1840 |
"eventAction" : "last changed", |
| 1841 |
|
| 1842 |
|
| 1843 |
|
| 1844 |
<span class="grey">Newton & Hollenbeck Standards Track [Page 33]</span></pre> |
| 1845 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-34" ></span> |
| 1846 |
<span class="grey"><a href="./rfc7483">RFC 7483</a> RDAP JSON Responses March 2015</span> |
| 1847 |
|
| 1848 |
|
| 1849 |
"eventDate" : "1991-12-31T23:59:59Z" |
| 1850 |
} |
| 1851 |
] |
| 1852 |
}, |
| 1853 |
{ |
| 1854 |
"objectClassName" : "nameserver", |
| 1855 |
"handle" : "XXXX", |
| 1856 |
"ldhName" : "ns2.example.com", |
| 1857 |
"status" : [ "active" ], |
| 1858 |
"ipAddresses" : |
| 1859 |
{ |
| 1860 |
"v6" : [ "2001:db8::125", "2001:db8::126" ], |
| 1861 |
"v4" : [ "192.0.2.3", "192.0.2.4" ] |
| 1862 |
}, |
| 1863 |
"remarks" : |
| 1864 |
[ |
| 1865 |
{ |
| 1866 |
"description" : |
| 1867 |
[ |
| 1868 |
"She sells sea shells down by the sea shore.", |
| 1869 |
"Originally written by Terry Sullivan." |
| 1870 |
] |
| 1871 |
} |
| 1872 |
], |
| 1873 |
"links" : |
| 1874 |
[ |
| 1875 |
{ |
| 1876 |
"value" : "http://example.net/nameserver/XXXX", |
| 1877 |
"rel" : "self", |
| 1878 |
"href" : "http://example.net/nameserver/XXXX", |
| 1879 |
"type" : "application/rdap+json" |
| 1880 |
} |
| 1881 |
], |
| 1882 |
"events" : |
| 1883 |
[ |
| 1884 |
{ |
| 1885 |
"eventAction" : "registration", |
| 1886 |
"eventDate" : "1990-12-31T23:59:59Z" |
| 1887 |
}, |
| 1888 |
{ |
| 1889 |
"eventAction" : "last changed", |
| 1890 |
"eventDate" : "1991-12-31T23:59:59Z" |
| 1891 |
} |
| 1892 |
] |
| 1893 |
} |
| 1894 |
], |
| 1895 |
"secureDNS": |
| 1896 |
{ |
| 1897 |
|
| 1898 |
|
| 1899 |
|
| 1900 |
<span class="grey">Newton & Hollenbeck Standards Track [Page 34]</span></pre> |
| 1901 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-35" ></span> |
| 1902 |
<span class="grey"><a href="./rfc7483">RFC 7483</a> RDAP JSON Responses March 2015</span> |
| 1903 |
|
| 1904 |
|
| 1905 |
"zoneSigned": true, |
| 1906 |
"delegationSigned": true, |
| 1907 |
"maxSigLife": 604800, |
| 1908 |
"keyData": |
| 1909 |
[ |
| 1910 |
{ |
| 1911 |
"flags": 257, |
| 1912 |
"protocol": 3, |
| 1913 |
"algorithm": 1, |
| 1914 |
"publicKey": "AQPJ////4Q==", |
| 1915 |
"events": |
| 1916 |
[ |
| 1917 |
{ |
| 1918 |
"eventAction": "last changed", |
| 1919 |
"eventDate": "2012-07-23T05:15:47Z" |
| 1920 |
} |
| 1921 |
] |
| 1922 |
} |
| 1923 |
] |
| 1924 |
}, |
| 1925 |
"remarks" : |
| 1926 |
[ |
| 1927 |
{ |
| 1928 |
"description" : |
| 1929 |
[ |
| 1930 |
"She sells sea shells down by the sea shore.", |
| 1931 |
"Originally written by Terry Sullivan." |
| 1932 |
] |
| 1933 |
} |
| 1934 |
], |
| 1935 |
"links" : |
| 1936 |
[ |
| 1937 |
{ |
| 1938 |
"value": "http://example.net/domain/XXXX", |
| 1939 |
"rel" : "self", |
| 1940 |
"href" : "http://example.net/domain/XXXX", |
| 1941 |
"type" : "application/rdap+json" |
| 1942 |
} |
| 1943 |
], |
| 1944 |
"port43" : "whois.example.net", |
| 1945 |
"events" : |
| 1946 |
[ |
| 1947 |
{ |
| 1948 |
"eventAction" : "registration", |
| 1949 |
"eventDate" : "1990-12-31T23:59:59Z" |
| 1950 |
}, |
| 1951 |
{ |
| 1952 |
"eventAction" : "last changed", |
| 1953 |
|
| 1954 |
|
| 1955 |
|
| 1956 |
<span class="grey">Newton & Hollenbeck Standards Track [Page 35]</span></pre> |
| 1957 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-36" ></span> |
| 1958 |
<span class="grey"><a href="./rfc7483">RFC 7483</a> RDAP JSON Responses March 2015</span> |
| 1959 |
|
| 1960 |
|
| 1961 |
"eventDate" : "1991-12-31T23:59:59Z", |
| 1962 |
"eventActor" : "[email protected]" |
| 1963 |
}, |
| 1964 |
{ |
| 1965 |
"eventAction" : "transfer", |
| 1966 |
"eventDate" : "1991-12-31T23:59:59Z", |
| 1967 |
"eventActor" : "[email protected]" |
| 1968 |
}, |
| 1969 |
{ |
| 1970 |
"eventAction" : "expiration", |
| 1971 |
"eventDate" : "2016-12-31T23:59:59Z", |
| 1972 |
"eventActor" : "[email protected]" |
| 1973 |
} |
| 1974 |
], |
| 1975 |
"entities" : |
| 1976 |
[ |
| 1977 |
{ |
| 1978 |
"objectClassName" : "entity", |
| 1979 |
"handle" : "XXXX", |
| 1980 |
"vcardArray":[ |
| 1981 |
"vcard", |
| 1982 |
[ |
| 1983 |
["version", {}, "text", "4.0"], |
| 1984 |
["fn", {}, "text", "Joe User"], |
| 1985 |
["kind", {}, "text", "individual"], |
| 1986 |
["lang", { |
| 1987 |
"pref":"1" |
| 1988 |
}, "language-tag", "fr"], |
| 1989 |
["lang", { |
| 1990 |
"pref":"2" |
| 1991 |
}, "language-tag", "en"], |
| 1992 |
["org", { |
| 1993 |
"type":"work" |
| 1994 |
}, "text", "Example"], |
| 1995 |
["title", {}, "text", "Research Scientist"], |
| 1996 |
["role", {}, "text", "Project Lead"], |
| 1997 |
["adr", |
| 1998 |
{ "type":"work" }, |
| 1999 |
"text", |
| 2000 |
[ |
| 2001 |
"", |
| 2002 |
"Suite 1234", |
| 2003 |
"4321 Rue Somewhere", |
| 2004 |
"Quebec", |
| 2005 |
"QC", |
| 2006 |
"G1V 2M2", |
| 2007 |
"Canada" |
| 2008 |
] |
| 2009 |
|
| 2010 |
|
| 2011 |
|
| 2012 |
<span class="grey">Newton & Hollenbeck Standards Track [Page 36]</span></pre> |
| 2013 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-37" ></span> |
| 2014 |
<span class="grey"><a href="./rfc7483">RFC 7483</a> RDAP JSON Responses March 2015</span> |
| 2015 |
|
| 2016 |
|
| 2017 |
], |
| 2018 |
["tel", |
| 2019 |
{ "type":["work", "voice"], "pref":"1" }, |
| 2020 |
"uri", "tel:+1-555-555-1234;ext=102" |
| 2021 |
], |
| 2022 |
["email", |
| 2023 |
{ "type":"work" }, |
| 2024 |
"text", "[email protected]" |
| 2025 |
] |
| 2026 |
] |
| 2027 |
], |
| 2028 |
"status" : [ "validated", "locked" ], |
| 2029 |
"roles" : [ "registrant" ], |
| 2030 |
"remarks" : |
| 2031 |
[ |
| 2032 |
{ |
| 2033 |
"description" : |
| 2034 |
[ |
| 2035 |
"She sells sea shells down by the sea shore.", |
| 2036 |
"Originally written by Terry Sullivan." |
| 2037 |
] |
| 2038 |
} |
| 2039 |
], |
| 2040 |
"links" : |
| 2041 |
[ |
| 2042 |
{ |
| 2043 |
"value" : "http://example.net/entity/xxxx", |
| 2044 |
"rel" : "self", |
| 2045 |
"href" : "http://example.net/entity/xxxx", |
| 2046 |
"type" : "application/rdap+json" |
| 2047 |
} |
| 2048 |
], |
| 2049 |
"events" : |
| 2050 |
[ |
| 2051 |
{ |
| 2052 |
"eventAction" : "registration", |
| 2053 |
"eventDate" : "1990-12-31T23:59:59Z" |
| 2054 |
}, |
| 2055 |
{ |
| 2056 |
"eventAction" : "last changed", |
| 2057 |
"eventDate" : "1991-12-31T23:59:59Z" |
| 2058 |
} |
| 2059 |
] |
| 2060 |
} |
| 2061 |
] |
| 2062 |
} |
| 2063 |
|
| 2064 |
Figure 24 |
| 2065 |
|
| 2066 |
|
| 2067 |
|
| 2068 |
<span class="grey">Newton & Hollenbeck Standards Track [Page 37]</span></pre> |
| 2069 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-38" ></span> |
| 2070 |
<span class="grey"><a href="./rfc7483">RFC 7483</a> RDAP JSON Responses March 2015</span> |
| 2071 |
|
| 2072 |
|
| 2073 |
<span class="h3"><a class="selflink" id="section-5.4" href="#section-5.4">5.4</a>. The IP Network Object Class</span> |
| 2074 |
|
| 2075 |
The IP network object class models IP network registrations found in |
| 2076 |
RIRs and is the expected response for the "/ip" query as defined by |
| 2077 |
[<a href="./rfc7482" title=""Registration Data Access Protocol (RDAP) Query Format"">RFC7482</a>]. There is no equivalent object class for DNRs. The high- |
| 2078 |
level structure of the IP network object class consists of |
| 2079 |
information about the network registration and entities related to |
| 2080 |
the IP network (e.g., registrant information, contacts, etc.). |
| 2081 |
|
| 2082 |
The following is an elided example of the IP network object type |
| 2083 |
showing the high-level structure: |
| 2084 |
|
| 2085 |
{ |
| 2086 |
"objectClassName" : "ip network", |
| 2087 |
"handle" : "XXX", |
| 2088 |
... |
| 2089 |
"entities" : |
| 2090 |
[ |
| 2091 |
... |
| 2092 |
] |
| 2093 |
} |
| 2094 |
|
| 2095 |
Figure 25 |
| 2096 |
|
| 2097 |
The following is an example of the JSON object for the network |
| 2098 |
registration information. |
| 2099 |
|
| 2100 |
{ |
| 2101 |
"objectClassName" : "ip network", |
| 2102 |
"handle" : "XXXX-RIR", |
| 2103 |
"startAddress" : "2001:db8::", |
| 2104 |
"endAddress" : "2001:db8:0:ffff:ffff:ffff:ffff:ffff", |
| 2105 |
"ipVersion" : "v6", |
| 2106 |
"name": "NET-RTR-1", |
| 2107 |
"type" : "DIRECT ALLOCATION", |
| 2108 |
"country" : "AU", |
| 2109 |
"parentHandle" : "YYYY-RIR", |
| 2110 |
"status" : [ "active" ], |
| 2111 |
"remarks" : |
| 2112 |
[ |
| 2113 |
{ |
| 2114 |
"description" : |
| 2115 |
[ |
| 2116 |
"She sells sea shells down by the sea shore.", |
| 2117 |
"Originally written by Terry Sullivan." |
| 2118 |
] |
| 2119 |
} |
| 2120 |
], |
| 2121 |
|
| 2122 |
|
| 2123 |
|
| 2124 |
<span class="grey">Newton & Hollenbeck Standards Track [Page 38]</span></pre> |
| 2125 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-39" ></span> |
| 2126 |
<span class="grey"><a href="./rfc7483">RFC 7483</a> RDAP JSON Responses March 2015</span> |
| 2127 |
|
| 2128 |
|
| 2129 |
"links" : |
| 2130 |
[ |
| 2131 |
{ |
| 2132 |
"value" : "http://example.net/ip/2001:db8::/48", |
| 2133 |
"rel" : "self", |
| 2134 |
"href" : "http://example.net/ip/2001:db8::/48", |
| 2135 |
"type" : "application/rdap+json" |
| 2136 |
}, |
| 2137 |
{ |
| 2138 |
"value" : "http://example.net/ip/2001:db8::/48", |
| 2139 |
"rel" : "up", |
| 2140 |
"href" : "http://example.net/ip/2001:C00::/23", |
| 2141 |
"type" : "application/rdap+json" |
| 2142 |
} |
| 2143 |
], |
| 2144 |
"events" : |
| 2145 |
[ |
| 2146 |
{ |
| 2147 |
"eventAction" : "registration", |
| 2148 |
"eventDate" : "1990-12-31T23:59:59Z" |
| 2149 |
}, |
| 2150 |
{ |
| 2151 |
"eventAction" : "last changed", |
| 2152 |
"eventDate" : "1991-12-31T23:59:59Z" |
| 2153 |
} |
| 2154 |
], |
| 2155 |
"entities" : |
| 2156 |
[ |
| 2157 |
{ |
| 2158 |
"objectClassName" : "entity", |
| 2159 |
"handle" : "XXXX", |
| 2160 |
"vcardArray":[ |
| 2161 |
"vcard", |
| 2162 |
[ |
| 2163 |
["version", {}, "text", "4.0"], |
| 2164 |
["fn", {}, "text", "Joe User"], |
| 2165 |
["kind", {}, "text", "individual"], |
| 2166 |
["lang", { |
| 2167 |
"pref":"1" |
| 2168 |
}, "language-tag", "fr"], |
| 2169 |
["lang", { |
| 2170 |
"pref":"2" |
| 2171 |
}, "language-tag", "en"], |
| 2172 |
["org", { |
| 2173 |
"type":"work" |
| 2174 |
}, "text", "Example"], |
| 2175 |
["title", {}, "text", "Research Scientist"], |
| 2176 |
["role", {}, "text", "Project Lead"], |
| 2177 |
|
| 2178 |
|
| 2179 |
|
| 2180 |
<span class="grey">Newton & Hollenbeck Standards Track [Page 39]</span></pre> |
| 2181 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-40" ></span> |
| 2182 |
<span class="grey"><a href="./rfc7483">RFC 7483</a> RDAP JSON Responses March 2015</span> |
| 2183 |
|
| 2184 |
|
| 2185 |
["adr", |
| 2186 |
{ "type":"work" }, |
| 2187 |
"text", |
| 2188 |
[ |
| 2189 |
"", |
| 2190 |
"Suite 1234", |
| 2191 |
"4321 Rue Somewhere", |
| 2192 |
"Quebec", |
| 2193 |
"QC", |
| 2194 |
"G1V 2M2", |
| 2195 |
"Canada" |
| 2196 |
] |
| 2197 |
], |
| 2198 |
["tel", |
| 2199 |
{ "type":["work", "voice"], "pref":"1" }, |
| 2200 |
"uri", "tel:+1-555-555-1234;ext=102" |
| 2201 |
], |
| 2202 |
["email", |
| 2203 |
{ "type":"work" }, |
| 2204 |
"text", "[email protected]" |
| 2205 |
] |
| 2206 |
] |
| 2207 |
], |
| 2208 |
"roles" : [ "registrant" ], |
| 2209 |
"remarks" : |
| 2210 |
[ |
| 2211 |
{ |
| 2212 |
"description" : |
| 2213 |
[ |
| 2214 |
"She sells sea shells down by the sea shore.", |
| 2215 |
"Originally written by Terry Sullivan." |
| 2216 |
] |
| 2217 |
} |
| 2218 |
], |
| 2219 |
"links" : |
| 2220 |
[ |
| 2221 |
{ |
| 2222 |
"value" : "http://example.net/entity/xxxx", |
| 2223 |
"rel" : "self", |
| 2224 |
"href" : "http://example.net/entity/xxxx", |
| 2225 |
"type" : "application/rdap+json" |
| 2226 |
} |
| 2227 |
], |
| 2228 |
"events" : |
| 2229 |
[ |
| 2230 |
{ |
| 2231 |
"eventAction" : "registration", |
| 2232 |
"eventDate" : "1990-12-31T23:59:59Z" |
| 2233 |
|
| 2234 |
|
| 2235 |
|
| 2236 |
<span class="grey">Newton & Hollenbeck Standards Track [Page 40]</span></pre> |
| 2237 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-41" ></span> |
| 2238 |
<span class="grey"><a href="./rfc7483">RFC 7483</a> RDAP JSON Responses March 2015</span> |
| 2239 |
|
| 2240 |
|
| 2241 |
}, |
| 2242 |
{ |
| 2243 |
"eventAction" : "last changed", |
| 2244 |
"eventDate" : "1991-12-31T23:59:59Z" |
| 2245 |
} |
| 2246 |
] |
| 2247 |
} |
| 2248 |
] |
| 2249 |
} |
| 2250 |
|
| 2251 |
Figure 26 |
| 2252 |
|
| 2253 |
The IP network object class can contain the following members: |
| 2254 |
|
| 2255 |
o objectClassName -- the string "ip network" |
| 2256 |
|
| 2257 |
o handle -- a string representing an RIR-unique identifier of the |
| 2258 |
network registration |
| 2259 |
|
| 2260 |
o startAddress -- the starting IP address of the network, either |
| 2261 |
IPv4 or IPv6 |
| 2262 |
|
| 2263 |
o endAddress -- the ending IP address of the network, either IPv4 or |
| 2264 |
IPv6 |
| 2265 |
|
| 2266 |
o ipVersion -- a string signifying the IP protocol version of the |
| 2267 |
network: "v4" signifies an IPv4 network, and "v6" signifies an |
| 2268 |
IPv6 network |
| 2269 |
|
| 2270 |
o name -- an identifier assigned to the network registration by the |
| 2271 |
registration holder |
| 2272 |
|
| 2273 |
o type -- a string containing an RIR-specific classification of the |
| 2274 |
network |
| 2275 |
|
| 2276 |
o country -- a string containing the two-character country code of |
| 2277 |
the network |
| 2278 |
|
| 2279 |
o parentHandle -- a string containing an RIR-unique identifier of |
| 2280 |
the parent network of this network registration |
| 2281 |
|
| 2282 |
o status -- an array of strings indicating the state of the IP |
| 2283 |
network |
| 2284 |
|
| 2285 |
o entities -- an array of entity objects as defined by <a href="#section-5.1">Section 5.1</a> |
| 2286 |
|
| 2287 |
o remarks -- see <a href="#section-4.3">Section 4.3</a> |
| 2288 |
|
| 2289 |
|
| 2290 |
|
| 2291 |
|
| 2292 |
<span class="grey">Newton & Hollenbeck Standards Track [Page 41]</span></pre> |
| 2293 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-42" ></span> |
| 2294 |
<span class="grey"><a href="./rfc7483">RFC 7483</a> RDAP JSON Responses March 2015</span> |
| 2295 |
|
| 2296 |
|
| 2297 |
o links -- see <a href="#section-4.2">Section 4.2</a> |
| 2298 |
|
| 2299 |
o port43 -- see <a href="#section-4.7">Section 4.7</a> |
| 2300 |
|
| 2301 |
o events -- see <a href="#section-4.5">Section 4.5</a> |
| 2302 |
|
| 2303 |
<span class="h3"><a class="selflink" id="section-5.5" href="#section-5.5">5.5</a>. Autonomous System Number Entity Object Class</span> |
| 2304 |
|
| 2305 |
The Autonomous System number (autnum) object class models Autonomous |
| 2306 |
System number registrations found in RIRs and represents the expected |
| 2307 |
response to an "/autnum" query as defined by [<a href="./rfc7482" title=""Registration Data Access Protocol (RDAP) Query Format"">RFC7482</a>]. There is no |
| 2308 |
equivalent object class for DNRs. The high-level structure of the |
| 2309 |
autnum object class consists of information about the network |
| 2310 |
registration and entities related to the autnum registration (e.g., |
| 2311 |
registrant information, contacts, etc.) and is similar to the IP |
| 2312 |
network entity object class. |
| 2313 |
|
| 2314 |
The following is an example of a JSON object representing an autnum. |
| 2315 |
|
| 2316 |
{ |
| 2317 |
"objectClassName" : "autnum", |
| 2318 |
"handle" : "XXXX-RIR", |
| 2319 |
"startAutnum" : 10, |
| 2320 |
"endAutnum" : 15, |
| 2321 |
"name": "AS-RTR-1", |
| 2322 |
"type" : "DIRECT ALLOCATION", |
| 2323 |
"status" : [ "active" ], |
| 2324 |
"country": "AU", |
| 2325 |
"remarks" : |
| 2326 |
[ |
| 2327 |
{ |
| 2328 |
"description" : |
| 2329 |
[ |
| 2330 |
"She sells sea shells down by the sea shore.", |
| 2331 |
"Originally written by Terry Sullivan." |
| 2332 |
] |
| 2333 |
} |
| 2334 |
], |
| 2335 |
"links" : |
| 2336 |
[ |
| 2337 |
{ |
| 2338 |
"value" : "http://example.net/autnum/xxxx", |
| 2339 |
"rel" : "self", |
| 2340 |
"href" : "http://example.net/autnum/xxxx", |
| 2341 |
"type" : "application/rdap+json" |
| 2342 |
} |
| 2343 |
], |
| 2344 |
"events" : |
| 2345 |
|
| 2346 |
|
| 2347 |
|
| 2348 |
<span class="grey">Newton & Hollenbeck Standards Track [Page 42]</span></pre> |
| 2349 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-43" ></span> |
| 2350 |
<span class="grey"><a href="./rfc7483">RFC 7483</a> RDAP JSON Responses March 2015</span> |
| 2351 |
|
| 2352 |
|
| 2353 |
[ |
| 2354 |
{ |
| 2355 |
"eventAction" : "registration", |
| 2356 |
"eventDate" : "1990-12-31T23:59:59Z" |
| 2357 |
}, |
| 2358 |
{ |
| 2359 |
"eventAction" : "last changed", |
| 2360 |
"eventDate" : "1991-12-31T23:59:59Z" |
| 2361 |
} |
| 2362 |
], |
| 2363 |
"entities" : |
| 2364 |
[ |
| 2365 |
{ |
| 2366 |
"objectClassName" : "entity", |
| 2367 |
"handle" : "XXXX", |
| 2368 |
"vcardArray":[ |
| 2369 |
"vcard", |
| 2370 |
[ |
| 2371 |
["version", {}, "text", "4.0"], |
| 2372 |
["fn", {}, "text", "Joe User"], |
| 2373 |
["kind", {}, "text", "individual"], |
| 2374 |
["lang", { |
| 2375 |
"pref":"1" |
| 2376 |
}, "language-tag", "fr"], |
| 2377 |
["lang", { |
| 2378 |
"pref":"2" |
| 2379 |
}, "language-tag", "en"], |
| 2380 |
["org", { |
| 2381 |
"type":"work" |
| 2382 |
}, "text", "Example"], |
| 2383 |
["title", {}, "text", "Research Scientist"], |
| 2384 |
["role", {}, "text", "Project Lead"], |
| 2385 |
["adr", |
| 2386 |
{ "type":"work" }, |
| 2387 |
"text", |
| 2388 |
[ |
| 2389 |
"", |
| 2390 |
"Suite 1234", |
| 2391 |
"4321 Rue Somewhere", |
| 2392 |
"Quebec", |
| 2393 |
"QC", |
| 2394 |
"G1V 2M2", |
| 2395 |
"Canada" |
| 2396 |
] |
| 2397 |
], |
| 2398 |
["tel", |
| 2399 |
{ "type":["work", "voice"], "pref":"1" }, |
| 2400 |
"uri", "tel:+1-555-555-1234;ext=102" |
| 2401 |
|
| 2402 |
|
| 2403 |
|
| 2404 |
<span class="grey">Newton & Hollenbeck Standards Track [Page 43]</span></pre> |
| 2405 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-44" ></span> |
| 2406 |
<span class="grey"><a href="./rfc7483">RFC 7483</a> RDAP JSON Responses March 2015</span> |
| 2407 |
|
| 2408 |
|
| 2409 |
], |
| 2410 |
["email", |
| 2411 |
{ "type":"work" }, |
| 2412 |
"text", "[email protected]" |
| 2413 |
] |
| 2414 |
] |
| 2415 |
], |
| 2416 |
"roles" : [ "registrant" ], |
| 2417 |
"remarks" : |
| 2418 |
[ |
| 2419 |
{ |
| 2420 |
"description" : |
| 2421 |
[ |
| 2422 |
"She sells sea shells down by the sea shore.", |
| 2423 |
"Originally written by Terry Sullivan." |
| 2424 |
] |
| 2425 |
} |
| 2426 |
], |
| 2427 |
"links" : |
| 2428 |
[ |
| 2429 |
{ |
| 2430 |
"value" : "http://example.net/entity/XXXX", |
| 2431 |
"rel" : "self", |
| 2432 |
"href" : "http://example.net/entity/XXXX", |
| 2433 |
"type" : "application/rdap+json" |
| 2434 |
} |
| 2435 |
], |
| 2436 |
"events" : |
| 2437 |
[ |
| 2438 |
{ |
| 2439 |
"eventAction" : "registration", |
| 2440 |
"eventDate" : "1990-12-31T23:59:59Z" |
| 2441 |
}, |
| 2442 |
{ |
| 2443 |
"eventAction" : "last changed", |
| 2444 |
"eventDate" : "1991-12-31T23:59:59Z" |
| 2445 |
} |
| 2446 |
] |
| 2447 |
} |
| 2448 |
] |
| 2449 |
} |
| 2450 |
|
| 2451 |
Figure 27 |
| 2452 |
|
| 2453 |
|
| 2454 |
|
| 2455 |
|
| 2456 |
|
| 2457 |
|
| 2458 |
|
| 2459 |
|
| 2460 |
<span class="grey">Newton & Hollenbeck Standards Track [Page 44]</span></pre> |
| 2461 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-45" ></span> |
| 2462 |
<span class="grey"><a href="./rfc7483">RFC 7483</a> RDAP JSON Responses March 2015</span> |
| 2463 |
|
| 2464 |
|
| 2465 |
The Autonomous System number object class can contain the following |
| 2466 |
members: |
| 2467 |
|
| 2468 |
o objectClassName -- the string "autnum" |
| 2469 |
|
| 2470 |
o handle -- a string representing an RIR-unique identifier of the |
| 2471 |
autnum registration |
| 2472 |
|
| 2473 |
o startAutnum -- a number representing the starting number [<a href="./rfc5396" title=""Textual Representation of Autonomous System (AS) Numbers"">RFC5396</a>] |
| 2474 |
in the block of Autonomous System numbers |
| 2475 |
|
| 2476 |
o endAutnum -- a number representing the ending number [<a href="./rfc5396" title=""Textual Representation of Autonomous System (AS) Numbers"">RFC5396</a>] in |
| 2477 |
the block of Autonomous System numbers |
| 2478 |
|
| 2479 |
o name -- an identifier assigned to the autnum registration by the |
| 2480 |
registration holder |
| 2481 |
|
| 2482 |
o type -- a string containing an RIR-specific classification of the |
| 2483 |
autnum |
| 2484 |
|
| 2485 |
o status -- an array of strings indicating the state of the autnum |
| 2486 |
|
| 2487 |
o country -- a string containing the name of the two-character |
| 2488 |
country code of the autnum |
| 2489 |
|
| 2490 |
o entities -- an array of entity objects as defined by <a href="#section-5.1">Section 5.1</a> |
| 2491 |
|
| 2492 |
o remarks -- see <a href="#section-4.3">Section 4.3</a> |
| 2493 |
|
| 2494 |
o links -- see <a href="#section-4.2">Section 4.2</a> |
| 2495 |
|
| 2496 |
o port43 -- see <a href="#section-4.7">Section 4.7</a> |
| 2497 |
|
| 2498 |
o events -- see <a href="#section-4.5">Section 4.5</a> |
| 2499 |
|
| 2500 |
<span class="h2"><a class="selflink" id="section-6" href="#section-6">6</a>. Error Response Body</span> |
| 2501 |
|
| 2502 |
Some non-answer responses may return entity bodies with information |
| 2503 |
that could be more descriptive. |
| 2504 |
|
| 2505 |
The basic structure of that response is an object class containing an |
| 2506 |
error code number (corresponding to the HTTP response code) followed |
| 2507 |
by a string named "title" and an array of strings named |
| 2508 |
"description". |
| 2509 |
|
| 2510 |
|
| 2511 |
|
| 2512 |
|
| 2513 |
|
| 2514 |
|
| 2515 |
|
| 2516 |
<span class="grey">Newton & Hollenbeck Standards Track [Page 45]</span></pre> |
| 2517 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-46" ></span> |
| 2518 |
<span class="grey"><a href="./rfc7483">RFC 7483</a> RDAP JSON Responses March 2015</span> |
| 2519 |
|
| 2520 |
|
| 2521 |
This is an example of the common response body. |
| 2522 |
|
| 2523 |
{ |
| 2524 |
"errorCode": 418, |
| 2525 |
"title": "Your Beverage Choice is Not Available", |
| 2526 |
"description": |
| 2527 |
[ |
| 2528 |
"I know coffee has more ummppphhh.", |
| 2529 |
"Sorry, dude!" |
| 2530 |
] |
| 2531 |
} |
| 2532 |
|
| 2533 |
Figure 28 |
| 2534 |
|
| 2535 |
|
| 2536 |
|
| 2537 |
|
| 2538 |
|
| 2539 |
|
| 2540 |
|
| 2541 |
|
| 2542 |
|
| 2543 |
|
| 2544 |
|
| 2545 |
|
| 2546 |
|
| 2547 |
|
| 2548 |
|
| 2549 |
|
| 2550 |
|
| 2551 |
|
| 2552 |
|
| 2553 |
|
| 2554 |
|
| 2555 |
|
| 2556 |
|
| 2557 |
|
| 2558 |
|
| 2559 |
|
| 2560 |
|
| 2561 |
|
| 2562 |
|
| 2563 |
|
| 2564 |
|
| 2565 |
|
| 2566 |
|
| 2567 |
|
| 2568 |
|
| 2569 |
|
| 2570 |
|
| 2571 |
|
| 2572 |
<span class="grey">Newton & Hollenbeck Standards Track [Page 46]</span></pre> |
| 2573 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-47" ></span> |
| 2574 |
<span class="grey"><a href="./rfc7483">RFC 7483</a> RDAP JSON Responses March 2015</span> |
| 2575 |
|
| 2576 |
|
| 2577 |
This is an example of the common response body with an |
| 2578 |
rdapConformance and notices data structures: |
| 2579 |
|
| 2580 |
{ |
| 2581 |
"rdapConformance" : |
| 2582 |
[ |
| 2583 |
"rdap_level_0" |
| 2584 |
], |
| 2585 |
"notices" : |
| 2586 |
[ |
| 2587 |
{ |
| 2588 |
"title" : "Beverage Policy", |
| 2589 |
"description" : |
| 2590 |
[ |
| 2591 |
"Beverages with caffeine for keeping horses awake." |
| 2592 |
], |
| 2593 |
"links" : |
| 2594 |
[ |
| 2595 |
{ |
| 2596 |
"value" : "http://example.net/ip/192.0.2.0/24", |
| 2597 |
"rel" : "alternate", |
| 2598 |
"type" : "text/html", |
| 2599 |
"href" : "http://www.example.com/redaction_policy.html" |
| 2600 |
} |
| 2601 |
] |
| 2602 |
} |
| 2603 |
], |
| 2604 |
"lang" : "en", |
| 2605 |
"errorCode": 418, |
| 2606 |
"title": "Your beverage choice is not available", |
| 2607 |
"description": |
| 2608 |
[ |
| 2609 |
"I know coffee has more ummppphhh.", |
| 2610 |
"Sorry, dude!" |
| 2611 |
] |
| 2612 |
} |
| 2613 |
|
| 2614 |
Figure 29 |
| 2615 |
|
| 2616 |
|
| 2617 |
|
| 2618 |
|
| 2619 |
|
| 2620 |
|
| 2621 |
|
| 2622 |
|
| 2623 |
|
| 2624 |
|
| 2625 |
|
| 2626 |
|
| 2627 |
|
| 2628 |
<span class="grey">Newton & Hollenbeck Standards Track [Page 47]</span></pre> |
| 2629 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-48" ></span> |
| 2630 |
<span class="grey"><a href="./rfc7483">RFC 7483</a> RDAP JSON Responses March 2015</span> |
| 2631 |
|
| 2632 |
|
| 2633 |
<span class="h2"><a class="selflink" id="section-7" href="#section-7">7</a>. Responding to Help Queries</span> |
| 2634 |
|
| 2635 |
The appropriate response to /help queries as defined by [<a href="./rfc7482" title=""Registration Data Access Protocol (RDAP) Query Format"">RFC7482</a>] is |
| 2636 |
to use the notices structure as defined in <a href="#section-4.3">Section 4.3</a>. |
| 2637 |
|
| 2638 |
This is an example of a response to a /help query including the |
| 2639 |
rdapConformance data structure. |
| 2640 |
|
| 2641 |
{ |
| 2642 |
"rdapConformance" : |
| 2643 |
[ |
| 2644 |
"rdap_level_0" |
| 2645 |
], |
| 2646 |
"notices" : |
| 2647 |
[ |
| 2648 |
{ |
| 2649 |
"title" : "Authentication Policy", |
| 2650 |
"description" : |
| 2651 |
[ |
| 2652 |
"Access to sensitive data for users with proper credentials." |
| 2653 |
], |
| 2654 |
"links" : |
| 2655 |
[ |
| 2656 |
{ |
| 2657 |
"value" : "http://example.net/help", |
| 2658 |
"rel" : "alternate", |
| 2659 |
"type" : "text/html", |
| 2660 |
"href" : "http://www.example.com/auth_policy.html" |
| 2661 |
} |
| 2662 |
] |
| 2663 |
} |
| 2664 |
] |
| 2665 |
} |
| 2666 |
|
| 2667 |
Figure 30 |
| 2668 |
|
| 2669 |
<span class="h2"><a class="selflink" id="section-8" href="#section-8">8</a>. Responding To Searches</span> |
| 2670 |
|
| 2671 |
[<a id="ref-RFC7482">RFC7482</a>] specifies three types of searches: domains, nameservers, |
| 2672 |
and entities. Responses to these searches take the form of an array |
| 2673 |
of object instances where each instance is an appropriate object |
| 2674 |
class for the search (i.e., a search for /domains yields an array of |
| 2675 |
domain object instances). These arrays are contained within the |
| 2676 |
response object. |
| 2677 |
|
| 2678 |
|
| 2679 |
|
| 2680 |
|
| 2681 |
|
| 2682 |
|
| 2683 |
|
| 2684 |
<span class="grey">Newton & Hollenbeck Standards Track [Page 48]</span></pre> |
| 2685 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-49" ></span> |
| 2686 |
<span class="grey"><a href="./rfc7483">RFC 7483</a> RDAP JSON Responses March 2015</span> |
| 2687 |
|
| 2688 |
|
| 2689 |
The names of the arrays are as follows: |
| 2690 |
|
| 2691 |
o for /domains searches, the array is "domainSearchResults" |
| 2692 |
|
| 2693 |
o for /nameservers searches, the array is "nameserverSearchResults" |
| 2694 |
|
| 2695 |
o for /entities searches, the array is "entitySearchResults" |
| 2696 |
|
| 2697 |
The following is an elided example of a response to a /domains |
| 2698 |
search. |
| 2699 |
|
| 2700 |
{ |
| 2701 |
"rdapConformance" : |
| 2702 |
[ |
| 2703 |
"rdap_level_0" |
| 2704 |
], |
| 2705 |
... |
| 2706 |
"domainSearchResults" : |
| 2707 |
[ |
| 2708 |
{ |
| 2709 |
"objectClassName" : "domain", |
| 2710 |
"handle" : "1-XXXX", |
| 2711 |
"ldhName" : "1.example.com", |
| 2712 |
... |
| 2713 |
}, |
| 2714 |
{ |
| 2715 |
"objectClassName" : "domain", |
| 2716 |
"handle" : "2-XXXX", |
| 2717 |
"ldhName" : "2.example.com", |
| 2718 |
... |
| 2719 |
} |
| 2720 |
] |
| 2721 |
} |
| 2722 |
|
| 2723 |
Figure 31 |
| 2724 |
|
| 2725 |
<span class="h2"><a class="selflink" id="section-9" href="#section-9">9</a>. Indicating Truncated Responses</span> |
| 2726 |
|
| 2727 |
In cases where the data of a response needs to be limited or parts of |
| 2728 |
the data need to be omitted, the response is considered "truncated". |
| 2729 |
A truncated response is still valid JSON, but some of the results in |
| 2730 |
a search set or some of the data in an object are not provided by the |
| 2731 |
server. A server may indicate this by including a typed notice in |
| 2732 |
the response object. |
| 2733 |
|
| 2734 |
The following is an elided example of a search response that has been |
| 2735 |
truncated. |
| 2736 |
|
| 2737 |
|
| 2738 |
|
| 2739 |
|
| 2740 |
<span class="grey">Newton & Hollenbeck Standards Track [Page 49]</span></pre> |
| 2741 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-50" ></span> |
| 2742 |
<span class="grey"><a href="./rfc7483">RFC 7483</a> RDAP JSON Responses March 2015</span> |
| 2743 |
|
| 2744 |
|
| 2745 |
{ |
| 2746 |
"rdapConformance" : |
| 2747 |
[ |
| 2748 |
"rdap_level_0" |
| 2749 |
], |
| 2750 |
"notices" : |
| 2751 |
[ |
| 2752 |
{ |
| 2753 |
"title" : "Search Policy", |
| 2754 |
"type" : "result set truncated due to authorization", |
| 2755 |
"description" : |
| 2756 |
[ |
| 2757 |
"Search results are limited to 25 per day per querying IP." |
| 2758 |
], |
| 2759 |
"links" : |
| 2760 |
[ |
| 2761 |
{ |
| 2762 |
"value" : "http://example.net/help", |
| 2763 |
"rel" : "alternate", |
| 2764 |
"type" : "text/html", |
| 2765 |
"href" : "http://www.example.com/search_policy.html" |
| 2766 |
} |
| 2767 |
] |
| 2768 |
} |
| 2769 |
], |
| 2770 |
"domainSearchResults" : |
| 2771 |
[ |
| 2772 |
... |
| 2773 |
] |
| 2774 |
} |
| 2775 |
|
| 2776 |
|
| 2777 |
Figure 32 |
| 2778 |
|
| 2779 |
A similar technique can be used with a typed remark where a single |
| 2780 |
object has been returned and data in that object has been truncated. |
| 2781 |
Such an example might be an entity object with only a partial set of |
| 2782 |
the IP networks associated with it. |
| 2783 |
|
| 2784 |
|
| 2785 |
|
| 2786 |
|
| 2787 |
|
| 2788 |
|
| 2789 |
|
| 2790 |
|
| 2791 |
|
| 2792 |
|
| 2793 |
|
| 2794 |
|
| 2795 |
|
| 2796 |
<span class="grey">Newton & Hollenbeck Standards Track [Page 50]</span></pre> |
| 2797 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-51" ></span> |
| 2798 |
<span class="grey"><a href="./rfc7483">RFC 7483</a> RDAP JSON Responses March 2015</span> |
| 2799 |
|
| 2800 |
|
| 2801 |
The following is an elided example of an entity truncated data. |
| 2802 |
|
| 2803 |
{ |
| 2804 |
"objectClassName" : "entity", |
| 2805 |
"handle" : "ANENTITY", |
| 2806 |
"roles" : [ "registrant" ], |
| 2807 |
... |
| 2808 |
"entities" : |
| 2809 |
[ |
| 2810 |
{ |
| 2811 |
"objectClassName" : "entity", |
| 2812 |
"handle": "ANEMBEDDEDENTITY", |
| 2813 |
"roles" : [ "technical" ], |
| 2814 |
... |
| 2815 |
}, |
| 2816 |
... |
| 2817 |
], |
| 2818 |
"networks" : |
| 2819 |
[ |
| 2820 |
... |
| 2821 |
], |
| 2822 |
... |
| 2823 |
"remarks" : |
| 2824 |
[ |
| 2825 |
{ |
| 2826 |
"title" : "Data Policy", |
| 2827 |
"type" : "object truncated due to unexplainable reason", |
| 2828 |
"description" : |
| 2829 |
[ |
| 2830 |
"Some of the data in this object has been removed." |
| 2831 |
], |
| 2832 |
"links" : |
| 2833 |
[ |
| 2834 |
{ |
| 2835 |
"value" : "http://example.net/help", |
| 2836 |
"rel" : "alternate", |
| 2837 |
"type" : "text/html", |
| 2838 |
"href" : "http://www.example.com/data_policy.html" |
| 2839 |
} |
| 2840 |
] |
| 2841 |
} |
| 2842 |
] |
| 2843 |
} |
| 2844 |
|
| 2845 |
|
| 2846 |
Figure 33 |
| 2847 |
|
| 2848 |
|
| 2849 |
|
| 2850 |
|
| 2851 |
|
| 2852 |
<span class="grey">Newton & Hollenbeck Standards Track [Page 51]</span></pre> |
| 2853 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-52" ></span> |
| 2854 |
<span class="grey"><a href="./rfc7483">RFC 7483</a> RDAP JSON Responses March 2015</span> |
| 2855 |
|
| 2856 |
|
| 2857 |
<span class="h2"><a class="selflink" id="section-10" href="#section-10">10</a>. IANA Considerations</span> |
| 2858 |
|
| 2859 |
<span class="h3"><a class="selflink" id="section-10.1" href="#section-10.1">10.1</a>. RDAP JSON Media Type Registration</span> |
| 2860 |
|
| 2861 |
This specification registers the "application/rdap+json" media type. |
| 2862 |
|
| 2863 |
Type name: application |
| 2864 |
|
| 2865 |
Subtype name: rdap+json |
| 2866 |
|
| 2867 |
Required parameters: n/a |
| 2868 |
|
| 2869 |
Encoding considerations: See <a href="./rfc6839#section-3.1">Section 3.1 of [RFC6839]</a>. |
| 2870 |
|
| 2871 |
Security considerations: The media represented by this identifier |
| 2872 |
does not have security considerations beyond that found in |
| 2873 |
<a href="./rfc7159#section-6">Section 6 of [RFC7159]</a>. |
| 2874 |
|
| 2875 |
Interoperability considerations: There are no known |
| 2876 |
interoperability problems regarding this media format. |
| 2877 |
|
| 2878 |
Published specification: <a href="./rfc7483">RFC 7483</a> |
| 2879 |
|
| 2880 |
Applications that use this media type: Implementations of the |
| 2881 |
Registration Data Access Protocol (RDAP). |
| 2882 |
|
| 2883 |
Additional information: This media type is a product of the IETF |
| 2884 |
WEIRDS working group. The WEIRDS charter, information on the |
| 2885 |
WEIRDS mailing list, and other documents produced by the WEIRDS |
| 2886 |
working group can be found at |
| 2887 |
<<a href="https://datatracker.ietf.org/wg/weirds/">https://datatracker.ietf.org/wg/weirds/</a>>. |
| 2888 |
|
| 2889 |
Person & email address to contact for further information: IESG |
| 2890 |
<[email protected]> |
| 2891 |
|
| 2892 |
Intended usage: COMMON |
| 2893 |
|
| 2894 |
Restrictions on usage: none |
| 2895 |
|
| 2896 |
Author: Andy Newton |
| 2897 |
|
| 2898 |
Change controller: IETF |
| 2899 |
|
| 2900 |
Provisional Registration: No (upon publication of this RFC) |
| 2901 |
|
| 2902 |
|
| 2903 |
|
| 2904 |
|
| 2905 |
|
| 2906 |
|
| 2907 |
|
| 2908 |
<span class="grey">Newton & Hollenbeck Standards Track [Page 52]</span></pre> |
| 2909 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-53" ></span> |
| 2910 |
<span class="grey"><a href="./rfc7483">RFC 7483</a> RDAP JSON Responses March 2015</span> |
| 2911 |
|
| 2912 |
|
| 2913 |
<span class="h3"><a class="selflink" id="section-10.2" href="#section-10.2">10.2</a>. JSON Values Registry</span> |
| 2914 |
|
| 2915 |
IANA has created a category in the protocol registries labeled |
| 2916 |
"Registration Data Access Protocol (RDAP)", and within that category, |
| 2917 |
IANA has established a URL-referenceable, stand-alone registry |
| 2918 |
labeled "RDAP JSON Values". This new registry is for use in the |
| 2919 |
notices and remarks (<a href="#section-4.3">Section 4.3</a>), status (<a href="#section-4.6">Section 4.6</a>), role |
| 2920 |
(<a href="#section-5.1">Section 5.1</a>), event action (<a href="#section-4.5">Section 4.5</a>), and domain variant |
| 2921 |
relation (<a href="#section-5.3">Section 5.3</a>) fields specified in RDAP. |
| 2922 |
|
| 2923 |
Each entry in the registry contains the following fields: |
| 2924 |
|
| 2925 |
1. Value -- the string value being registered. |
| 2926 |
|
| 2927 |
2. Type -- the type of value being registered. It should be one of |
| 2928 |
the following: |
| 2929 |
|
| 2930 |
* "notice or remark type" -- denotes a type of notice or remark. |
| 2931 |
|
| 2932 |
* "status" -- denotes a value for the "status" object member as |
| 2933 |
defined by <a href="#section-4.6">Section 4.6</a>. |
| 2934 |
|
| 2935 |
* "role" -- denotes a value for the "role" array as defined in |
| 2936 |
<a href="#section-5.1">Section 5.1</a>. |
| 2937 |
|
| 2938 |
* "event action" -- denotes a value for an event action as |
| 2939 |
defined in <a href="#section-4.5">Section 4.5</a>. |
| 2940 |
|
| 2941 |
* "domain variant relation" -- denotes a relationship between a |
| 2942 |
domain and a domain variant as defined in <a href="#section-5.3">Section 5.3</a>. |
| 2943 |
|
| 2944 |
3. Description -- a one- or two-sentence description regarding the |
| 2945 |
meaning of the value, how it might be used, and/or how it should |
| 2946 |
be interpreted by clients. |
| 2947 |
|
| 2948 |
4. Registrant Name -- the name of the person registering the value. |
| 2949 |
|
| 2950 |
5. Registrant Contact Information -- an email address, postal |
| 2951 |
address, or some other information to be used to contact the |
| 2952 |
registrant. |
| 2953 |
|
| 2954 |
This registry is operated under the "Expert Review" policy defined in |
| 2955 |
[<a href="./rfc5226" title="">RFC5226</a>]. |
| 2956 |
|
| 2957 |
|
| 2958 |
|
| 2959 |
|
| 2960 |
|
| 2961 |
|
| 2962 |
|
| 2963 |
|
| 2964 |
<span class="grey">Newton & Hollenbeck Standards Track [Page 53]</span></pre> |
| 2965 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-54" ></span> |
| 2966 |
<span class="grey"><a href="./rfc7483">RFC 7483</a> RDAP JSON Responses March 2015</span> |
| 2967 |
|
| 2968 |
|
| 2969 |
Review of registrations into this registry by the designated |
| 2970 |
expert(s) should be narrowly judged on the following criteria: |
| 2971 |
|
| 2972 |
1. Values in need of being placed into multiple types must be |
| 2973 |
assigned a separate registration for each type. |
| 2974 |
|
| 2975 |
2. Values must be strings. They should be multiple words separated |
| 2976 |
by single space characters. Every character should be |
| 2977 |
lowercased. If possible, every word should be given in English |
| 2978 |
and each character should be US-ASCII. |
| 2979 |
|
| 2980 |
3. Registrations should not duplicate the meaning of any existing |
| 2981 |
registration. That is, if a request for a registration is |
| 2982 |
significantly similar in nature to an existing registration, the |
| 2983 |
request should be denied. For example, the terms "maintainer" |
| 2984 |
and "registrant" are significantly similar in nature as they both |
| 2985 |
denote a holder of a domain name or Internet number resource. In |
| 2986 |
cases where it may be reasonably argued that machine |
| 2987 |
interpretation of two similar values may alter the operation of |
| 2988 |
client software, designated experts should not judge the values |
| 2989 |
to be of significant similarity. |
| 2990 |
|
| 2991 |
4. Registrations should be relevant to the common usages of RDAP. |
| 2992 |
Designated experts may rely upon the serving of the value by a |
| 2993 |
DNR or RIR to make this determination. |
| 2994 |
|
| 2995 |
The following sections provide initial registrations into this |
| 2996 |
registry. |
| 2997 |
|
| 2998 |
<span class="h4"><a class="selflink" id="section-10.2.1" href="#section-10.2.1">10.2.1</a>. Notice and Remark Types</span> |
| 2999 |
|
| 3000 |
The following values have been registered in the "RDAP JSON Values" |
| 3001 |
registry: |
| 3002 |
|
| 3003 |
Value: result set truncated due to authorization |
| 3004 |
Type: notice and remark type |
| 3005 |
Description: The list of results does not contain all results due |
| 3006 |
to lack of authorization. This may indicate to some clients |
| 3007 |
that proper authorization will yield a longer result set. |
| 3008 |
Registrant Name: IESG |
| 3009 |
Registrant Contact Information: [email protected] |
| 3010 |
|
| 3011 |
|
| 3012 |
|
| 3013 |
|
| 3014 |
|
| 3015 |
|
| 3016 |
|
| 3017 |
|
| 3018 |
|
| 3019 |
|
| 3020 |
<span class="grey">Newton & Hollenbeck Standards Track [Page 54]</span></pre> |
| 3021 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-55" ></span> |
| 3022 |
<span class="grey"><a href="./rfc7483">RFC 7483</a> RDAP JSON Responses March 2015</span> |
| 3023 |
|
| 3024 |
|
| 3025 |
Value: result set truncated due to excessive load |
| 3026 |
Type: notice and remark type |
| 3027 |
Description: The list of results does not contain all results due |
| 3028 |
to an excessively heavy load on the server. This may indicate |
| 3029 |
to some clients that requerying at a later time will yield a |
| 3030 |
longer result set. |
| 3031 |
Registrant Name: IESG |
| 3032 |
Registrant Contact Information: [email protected] |
| 3033 |
|
| 3034 |
|
| 3035 |
Value: result set truncated due to unexplainable reasons |
| 3036 |
Type: notice and remark type |
| 3037 |
Description: The list of results does not contain all results for |
| 3038 |
an unexplainable reason. This may indicate to some clients |
| 3039 |
that requerying for any reason will not yield a longer result |
| 3040 |
set. |
| 3041 |
Registrant Name: IESG |
| 3042 |
Registrant Contact Information: [email protected] |
| 3043 |
|
| 3044 |
|
| 3045 |
Value: object truncated due to authorization |
| 3046 |
Type: notice and remark type |
| 3047 |
Description: The object does not contain all data due to lack of |
| 3048 |
authorization. |
| 3049 |
Registrant Name: IESG |
| 3050 |
Registrant Contact Information: [email protected] |
| 3051 |
|
| 3052 |
|
| 3053 |
Value: object truncated due to excessive load |
| 3054 |
Type: notice and remark type |
| 3055 |
Description: The object does not contain all data due to an |
| 3056 |
excessively heavy load on the server. This may indicate to |
| 3057 |
some clients that requerying at a later time will yield all |
| 3058 |
data of the object. |
| 3059 |
Registrant Name: IESG |
| 3060 |
Registrant Contact Information: [email protected] |
| 3061 |
|
| 3062 |
|
| 3063 |
Value: object truncated due to unexplainable reasons |
| 3064 |
Type: notice and remark type |
| 3065 |
Description: The object does not contain all data for an |
| 3066 |
unexplainable reason. |
| 3067 |
Registrant Name: IESG |
| 3068 |
Registrant Contact Information: [email protected] |
| 3069 |
|
| 3070 |
|
| 3071 |
|
| 3072 |
|
| 3073 |
|
| 3074 |
|
| 3075 |
|
| 3076 |
<span class="grey">Newton & Hollenbeck Standards Track [Page 55]</span></pre> |
| 3077 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-56" ></span> |
| 3078 |
<span class="grey"><a href="./rfc7483">RFC 7483</a> RDAP JSON Responses March 2015</span> |
| 3079 |
|
| 3080 |
|
| 3081 |
<span class="h4"><a class="selflink" id="section-10.2.2" href="#section-10.2.2">10.2.2</a>. Status</span> |
| 3082 |
|
| 3083 |
The following values have been registered in the "RDAP JSON Values" |
| 3084 |
registry: |
| 3085 |
|
| 3086 |
Value: validated |
| 3087 |
Type: status |
| 3088 |
Description: Signifies that the data of the object instance has |
| 3089 |
been found to be accurate. This type of status is usually |
| 3090 |
found on entity object instances to note the validity of |
| 3091 |
identifying contact information. |
| 3092 |
Registrant Name: IESG |
| 3093 |
Registrant Contact Information: [email protected] |
| 3094 |
|
| 3095 |
|
| 3096 |
Value: renew prohibited |
| 3097 |
Type: status |
| 3098 |
Description: Renewal or reregistration of the object instance is |
| 3099 |
forbidden. |
| 3100 |
Registrant Name: IESG |
| 3101 |
Registrant Contact Information: [email protected] |
| 3102 |
|
| 3103 |
|
| 3104 |
Value: update prohibited |
| 3105 |
Type: status |
| 3106 |
Description: Updates to the object instance are forbidden. |
| 3107 |
Registrant Name: IESG |
| 3108 |
Registrant Contact Information: [email protected] |
| 3109 |
|
| 3110 |
|
| 3111 |
Value: transfer prohibited |
| 3112 |
Type: status |
| 3113 |
Description: Transfers of the registration from one registrar to |
| 3114 |
another are forbidden. This type of status normally applies to |
| 3115 |
DNR domain names. |
| 3116 |
Registrant Name: IESG |
| 3117 |
Registrant Contact Information: [email protected] |
| 3118 |
|
| 3119 |
|
| 3120 |
Value: delete prohibited |
| 3121 |
Type: status |
| 3122 |
Description: Deletion of the registration of the object instance |
| 3123 |
is forbidden. This type of status normally applies to DNR |
| 3124 |
domain names. |
| 3125 |
Registrant Name: IESG |
| 3126 |
Registrant Contact Information: [email protected] |
| 3127 |
|
| 3128 |
|
| 3129 |
|
| 3130 |
|
| 3131 |
|
| 3132 |
<span class="grey">Newton & Hollenbeck Standards Track [Page 56]</span></pre> |
| 3133 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-57" ></span> |
| 3134 |
<span class="grey"><a href="./rfc7483">RFC 7483</a> RDAP JSON Responses March 2015</span> |
| 3135 |
|
| 3136 |
|
| 3137 |
Value: proxy |
| 3138 |
Type: status |
| 3139 |
Description: The registration of the object instance has been |
| 3140 |
performed by a third party. This is most commonly applied to |
| 3141 |
entities. |
| 3142 |
Registrant Name: IESG |
| 3143 |
Registrant Contact Information: [email protected] |
| 3144 |
|
| 3145 |
|
| 3146 |
Value: private |
| 3147 |
Type: status |
| 3148 |
Description: The information of the object instance is not |
| 3149 |
designated for public consumption. This is most commonly |
| 3150 |
applied to entities. |
| 3151 |
Registrant Name: IESG |
| 3152 |
Registrant Contact Information: [email protected] |
| 3153 |
|
| 3154 |
|
| 3155 |
Value: removed |
| 3156 |
Type: status |
| 3157 |
Description: Some of the information of the object instance has |
| 3158 |
not been made available and has been removed. This is most |
| 3159 |
commonly applied to entities. |
| 3160 |
Registrant Name: IESG |
| 3161 |
Registrant Contact Information: [email protected] |
| 3162 |
|
| 3163 |
|
| 3164 |
Value: obscured |
| 3165 |
Type: status |
| 3166 |
Description: Some of the information of the object instance has |
| 3167 |
been altered for the purposes of not readily revealing the |
| 3168 |
actual information of the object instance. This is most |
| 3169 |
commonly applied to entities. |
| 3170 |
Registrant Name: IESG |
| 3171 |
Registrant Contact Information: [email protected] |
| 3172 |
|
| 3173 |
|
| 3174 |
Value: associated |
| 3175 |
Type: status |
| 3176 |
Description: The object instance is associated with other object |
| 3177 |
instances in the registry. This is most commonly used to |
| 3178 |
signify that a nameserver is associated with a domain or that |
| 3179 |
an entity is associated with a network resource or domain. |
| 3180 |
Registrant Name: IESG |
| 3181 |
Registrant Contact Information: [email protected] |
| 3182 |
|
| 3183 |
|
| 3184 |
|
| 3185 |
|
| 3186 |
|
| 3187 |
|
| 3188 |
<span class="grey">Newton & Hollenbeck Standards Track [Page 57]</span></pre> |
| 3189 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-58" ></span> |
| 3190 |
<span class="grey"><a href="./rfc7483">RFC 7483</a> RDAP JSON Responses March 2015</span> |
| 3191 |
|
| 3192 |
|
| 3193 |
Value: active |
| 3194 |
Type: status |
| 3195 |
Description: The object instance is in use. For domain names, it |
| 3196 |
signifies that the domain name is published in DNS. For |
| 3197 |
network and autnum registrations, it signifies that they are |
| 3198 |
allocated or assigned for use in operational networks. This |
| 3199 |
maps to the "OK" status of the Extensible Provisioning Protocol |
| 3200 |
(EPP) [<a href="./rfc5730" title=""Extensible Provisioning Protocol (EPP)"">RFC5730</a>] . |
| 3201 |
Registrant Name: IESG |
| 3202 |
Registrant Contact Information: [email protected] |
| 3203 |
|
| 3204 |
|
| 3205 |
Value: inactive |
| 3206 |
Type: status |
| 3207 |
Description: The object instance is not in use. See "active". |
| 3208 |
Registrant Name: IESG |
| 3209 |
Registrant Contact Information: [email protected] |
| 3210 |
|
| 3211 |
|
| 3212 |
Value: locked |
| 3213 |
Type: status |
| 3214 |
Description: Changes to the object instance cannot be made, |
| 3215 |
including the association of other object instances. |
| 3216 |
Registrant Name: IESG |
| 3217 |
Registrant Contact Information: [email protected] |
| 3218 |
|
| 3219 |
|
| 3220 |
Value: pending create |
| 3221 |
Type: status |
| 3222 |
Description: A request has been received for the creation of the |
| 3223 |
object instance, but this action is not yet complete. |
| 3224 |
Registrant Name: IESG |
| 3225 |
Registrant Contact Information: [email protected] |
| 3226 |
|
| 3227 |
|
| 3228 |
Value: pending renew |
| 3229 |
Type: status |
| 3230 |
Description: A request has been received for the renewal of the |
| 3231 |
object instance, but this action is not yet complete. |
| 3232 |
Registrant Name: IESG |
| 3233 |
Registrant Contact Information: [email protected] |
| 3234 |
|
| 3235 |
|
| 3236 |
|
| 3237 |
|
| 3238 |
|
| 3239 |
|
| 3240 |
|
| 3241 |
|
| 3242 |
|
| 3243 |
|
| 3244 |
<span class="grey">Newton & Hollenbeck Standards Track [Page 58]</span></pre> |
| 3245 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-59" ></span> |
| 3246 |
<span class="grey"><a href="./rfc7483">RFC 7483</a> RDAP JSON Responses March 2015</span> |
| 3247 |
|
| 3248 |
|
| 3249 |
Value: pending transfer |
| 3250 |
Type: status |
| 3251 |
Description: A request has been received for the transfer of the |
| 3252 |
object instance, but this action is not yet complete. |
| 3253 |
Registrant Name: IESG |
| 3254 |
Registrant Contact Information: [email protected] |
| 3255 |
|
| 3256 |
|
| 3257 |
Value: pending update |
| 3258 |
Type: status |
| 3259 |
Description: A request has been received for the update or |
| 3260 |
modification of the object instance, but this action is not yet |
| 3261 |
complete. |
| 3262 |
Registrant Name: IESG |
| 3263 |
Registrant Contact Information: [email protected] |
| 3264 |
|
| 3265 |
|
| 3266 |
Value: pending delete |
| 3267 |
Type: status |
| 3268 |
Description: A request has been received for the deletion or |
| 3269 |
removal of the object instance, but this action is not yet |
| 3270 |
complete. For domains, this might mean that the name is no |
| 3271 |
longer published in DNS but has not yet been purged from the |
| 3272 |
registry database. |
| 3273 |
Registrant Name: IESG |
| 3274 |
Registrant Contact Information: [email protected] |
| 3275 |
|
| 3276 |
<span class="h4"><a class="selflink" id="section-10.2.3" href="#section-10.2.3">10.2.3</a>. Event Actions</span> |
| 3277 |
|
| 3278 |
The following values have been registered in the "RDAP JSON Values" |
| 3279 |
registry: |
| 3280 |
|
| 3281 |
Value: registration |
| 3282 |
Type: event action |
| 3283 |
Description: The object instance was initially registered. |
| 3284 |
Registrant Name: IESG |
| 3285 |
Registrant Contact Information: [email protected] |
| 3286 |
|
| 3287 |
|
| 3288 |
Value: reregistration |
| 3289 |
Type: event action |
| 3290 |
Description: The object instance was registered subsequently to |
| 3291 |
initial registration. |
| 3292 |
Registrant Name: IESG |
| 3293 |
Registrant Contact Information: [email protected] |
| 3294 |
|
| 3295 |
|
| 3296 |
|
| 3297 |
|
| 3298 |
|
| 3299 |
|
| 3300 |
<span class="grey">Newton & Hollenbeck Standards Track [Page 59]</span></pre> |
| 3301 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-60" ></span> |
| 3302 |
<span class="grey"><a href="./rfc7483">RFC 7483</a> RDAP JSON Responses March 2015</span> |
| 3303 |
|
| 3304 |
|
| 3305 |
Value: last changed |
| 3306 |
Type: event action |
| 3307 |
Description: An action noting when the information in the object |
| 3308 |
instance was last changed. |
| 3309 |
Registrant Name: IESG |
| 3310 |
Registrant Contact Information: [email protected] |
| 3311 |
|
| 3312 |
|
| 3313 |
Value: expiration |
| 3314 |
Type: event action |
| 3315 |
Description: The object instance has been removed or will be |
| 3316 |
removed at a predetermined date and time from the registry. |
| 3317 |
Registrant Name: IESG |
| 3318 |
Registrant Contact Information: [email protected] |
| 3319 |
|
| 3320 |
|
| 3321 |
Value: deletion |
| 3322 |
Type: event action |
| 3323 |
Description: The object instance was removed from the registry at |
| 3324 |
a point in time that was not predetermined. |
| 3325 |
Registrant Name: IESG |
| 3326 |
Registrant Contact Information: [email protected] |
| 3327 |
|
| 3328 |
|
| 3329 |
Value: reinstantiation |
| 3330 |
Type: event action |
| 3331 |
Description: The object instance was reregistered after having |
| 3332 |
been removed from the registry. |
| 3333 |
Registrant Name: IESG |
| 3334 |
Registrant Contact Information: [email protected] |
| 3335 |
|
| 3336 |
|
| 3337 |
Value: transfer |
| 3338 |
Type: event action |
| 3339 |
Description: The object instance was transferred from one |
| 3340 |
registrant to another. |
| 3341 |
Registrant Name: IESG |
| 3342 |
Registrant Contact Information: [email protected] |
| 3343 |
|
| 3344 |
|
| 3345 |
Value: locked |
| 3346 |
Type: event action |
| 3347 |
Description: The object instance was locked (see the "locked" |
| 3348 |
status). |
| 3349 |
Registrant Name: IESG |
| 3350 |
Registrant Contact Information: [email protected] |
| 3351 |
|
| 3352 |
|
| 3353 |
|
| 3354 |
|
| 3355 |
|
| 3356 |
<span class="grey">Newton & Hollenbeck Standards Track [Page 60]</span></pre> |
| 3357 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-61" ></span> |
| 3358 |
<span class="grey"><a href="./rfc7483">RFC 7483</a> RDAP JSON Responses March 2015</span> |
| 3359 |
|
| 3360 |
|
| 3361 |
Value: unlocked |
| 3362 |
Type: event action |
| 3363 |
Description: The object instance was unlocked (see the "locked" |
| 3364 |
status). |
| 3365 |
Registrant Name: IESG |
| 3366 |
Registrant Contact Information: [email protected] |
| 3367 |
|
| 3368 |
<span class="h4"><a class="selflink" id="section-10.2.4" href="#section-10.2.4">10.2.4</a>. Roles</span> |
| 3369 |
|
| 3370 |
The following values have been registered in the "RDAP JSON Values" |
| 3371 |
registry: |
| 3372 |
|
| 3373 |
Value: registrant |
| 3374 |
Type: role |
| 3375 |
Description: The entity object instance is the registrant of the |
| 3376 |
registration. In some registries, this is known as a |
| 3377 |
maintainer. |
| 3378 |
Registrant Name: IESG |
| 3379 |
Registrant Contact Information: [email protected] |
| 3380 |
|
| 3381 |
|
| 3382 |
Value: technical |
| 3383 |
Type: role |
| 3384 |
Description: The entity object instance is a technical contact for |
| 3385 |
the registration. |
| 3386 |
Registrant Name: IESG |
| 3387 |
Registrant Contact Information: [email protected] |
| 3388 |
|
| 3389 |
|
| 3390 |
Value: administrative |
| 3391 |
Type: role |
| 3392 |
Description: The entity object instance is an administrative |
| 3393 |
contact for the registration. |
| 3394 |
Registrant Name: IESG |
| 3395 |
Registrant Contact Information: [email protected] |
| 3396 |
|
| 3397 |
|
| 3398 |
Value: abuse |
| 3399 |
Type: role |
| 3400 |
Description: The entity object instance handles network abuse |
| 3401 |
issues on behalf of the registrant of the registration. |
| 3402 |
Registrant Name: IESG |
| 3403 |
Registrant Contact Information: [email protected] |
| 3404 |
|
| 3405 |
|
| 3406 |
|
| 3407 |
|
| 3408 |
|
| 3409 |
|
| 3410 |
|
| 3411 |
|
| 3412 |
<span class="grey">Newton & Hollenbeck Standards Track [Page 61]</span></pre> |
| 3413 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-62" ></span> |
| 3414 |
<span class="grey"><a href="./rfc7483">RFC 7483</a> RDAP JSON Responses March 2015</span> |
| 3415 |
|
| 3416 |
|
| 3417 |
Value: billing |
| 3418 |
Type: role |
| 3419 |
Description: The entity object instance handles payment and |
| 3420 |
billing issues on behalf of the registrant of the registration. |
| 3421 |
Registrant Name: IESG |
| 3422 |
Registrant Contact Information: [email protected] |
| 3423 |
|
| 3424 |
|
| 3425 |
Value: registrar |
| 3426 |
Type: role |
| 3427 |
Description: The entity object instance represents the authority |
| 3428 |
responsible for the registration in the registry. |
| 3429 |
Registrant Name: IESG |
| 3430 |
Registrant Contact Information: [email protected] |
| 3431 |
|
| 3432 |
|
| 3433 |
Value: reseller |
| 3434 |
Type: role |
| 3435 |
Description: The entity object instance represents a third party |
| 3436 |
through which the registration was conducted (i.e., not the |
| 3437 |
registry or registrar). |
| 3438 |
Registrant Name: IESG |
| 3439 |
Registrant Contact Information: [email protected] |
| 3440 |
|
| 3441 |
|
| 3442 |
Value: sponsor |
| 3443 |
Type: role |
| 3444 |
Description: The entity object instance represents a domain policy |
| 3445 |
sponsor, such as an ICANN-approved sponsor. |
| 3446 |
Registrant Name: IESG |
| 3447 |
Registrant Contact Information: [email protected] |
| 3448 |
|
| 3449 |
|
| 3450 |
Value: proxy |
| 3451 |
Type: role |
| 3452 |
Description: The entity object instance represents a proxy for |
| 3453 |
another entity object, such as a registrant. |
| 3454 |
Registrant Name: IESG |
| 3455 |
Registrant Contact Information: [email protected] |
| 3456 |
|
| 3457 |
|
| 3458 |
Value: notifications |
| 3459 |
Type: role |
| 3460 |
Description: An entity object instance designated to receive |
| 3461 |
notifications about association object instances. |
| 3462 |
Registrant Name: IESG |
| 3463 |
Registrant Contact Information: [email protected] |
| 3464 |
|
| 3465 |
|
| 3466 |
|
| 3467 |
|
| 3468 |
<span class="grey">Newton & Hollenbeck Standards Track [Page 62]</span></pre> |
| 3469 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-63" ></span> |
| 3470 |
<span class="grey"><a href="./rfc7483">RFC 7483</a> RDAP JSON Responses March 2015</span> |
| 3471 |
|
| 3472 |
|
| 3473 |
Value: noc |
| 3474 |
Type: role |
| 3475 |
Description: The entity object instance handles communications |
| 3476 |
related to a network operations center (NOC). |
| 3477 |
Registrant Name: IESG |
| 3478 |
Registrant Contact Information: [email protected] |
| 3479 |
|
| 3480 |
<span class="h4"><a class="selflink" id="section-10.2.5" href="#section-10.2.5">10.2.5</a>. Variant Relations</span> |
| 3481 |
|
| 3482 |
The following values have been registered in the "RDAP JSON Values" |
| 3483 |
registry: |
| 3484 |
|
| 3485 |
Value: registered |
| 3486 |
Type: domain variant relation |
| 3487 |
Description: The variant names are registered in the registry. |
| 3488 |
Registrant Name: IESG |
| 3489 |
Registrant Contact Information: [email protected] |
| 3490 |
|
| 3491 |
|
| 3492 |
Value: unregistered |
| 3493 |
Type: domain variant relation |
| 3494 |
Description: The variant names are not found in the registry. |
| 3495 |
Registrant Name: IESG |
| 3496 |
Registrant Contact Information: [email protected] |
| 3497 |
|
| 3498 |
|
| 3499 |
Value: registration restricted |
| 3500 |
Type: domain variant relation |
| 3501 |
Description: Registration of the variant names is restricted to |
| 3502 |
certain parties or within certain rules. |
| 3503 |
Registrant Name: IESG |
| 3504 |
Registrant Contact Information: [email protected] |
| 3505 |
|
| 3506 |
|
| 3507 |
Value: open registration |
| 3508 |
Type: domain variant relation |
| 3509 |
Description: Registration of the variant names is available to |
| 3510 |
generally qualified registrants. |
| 3511 |
Registrant Name: IESG |
| 3512 |
Registrant Contact Information: [email protected] |
| 3513 |
|
| 3514 |
|
| 3515 |
|
| 3516 |
|
| 3517 |
|
| 3518 |
|
| 3519 |
|
| 3520 |
|
| 3521 |
|
| 3522 |
|
| 3523 |
|
| 3524 |
<span class="grey">Newton & Hollenbeck Standards Track [Page 63]</span></pre> |
| 3525 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-64" ></span> |
| 3526 |
<span class="grey"><a href="./rfc7483">RFC 7483</a> RDAP JSON Responses March 2015</span> |
| 3527 |
|
| 3528 |
|
| 3529 |
Value: conjoined |
| 3530 |
Type: domain variant relation |
| 3531 |
Description: Registration of the variant names occurs |
| 3532 |
automatically with the registration of the containing domain |
| 3533 |
registration. |
| 3534 |
Registrant Name: IESG |
| 3535 |
Registrant Contact Information: [email protected] |
| 3536 |
|
| 3537 |
<span class="h2"><a class="selflink" id="section-11" href="#section-11">11</a>. Security Considerations</span> |
| 3538 |
|
| 3539 |
This specification models information serialized in JSON format. As |
| 3540 |
JSON is a subset of JavaScript, implementations are advised to follow |
| 3541 |
the security considerations outlined in <a href="./rfc7159#section-6">Section 6 of [RFC7159]</a> to |
| 3542 |
prevent code injection. |
| 3543 |
|
| 3544 |
Though not specific to JSON, RDAP implementers should be aware of the |
| 3545 |
security considerations specified in [<a href="./rfc7480" title=""HTTP Usage in the Registration Data Access Protocol (RDAP)"">RFC7480</a>] and the security |
| 3546 |
requirements and considerations in [<a href="./rfc7481" title=""Security Services for the Registration Data Access Protocol (RDAP)"">RFC7481</a>]. |
| 3547 |
|
| 3548 |
Clients caching data, especially clients using RDAP-specific caches |
| 3549 |
(instead of HTTP-layer caches), should have safeguards to prevent |
| 3550 |
cache poisoning. See <a href="#section-5">Section 5</a> for advice on using the self links |
| 3551 |
for caching. |
| 3552 |
|
| 3553 |
Finally, service operators should be aware of the privacy mechanisms |
| 3554 |
noted in <a href="#section-13">Section 13</a>. |
| 3555 |
|
| 3556 |
<span class="h2"><a class="selflink" id="section-12" href="#section-12">12</a>. Internationalization Considerations</span> |
| 3557 |
|
| 3558 |
<span class="h3"><a class="selflink" id="section-12.1" href="#section-12.1">12.1</a>. Character Encoding</span> |
| 3559 |
|
| 3560 |
The default text encoding for JSON responses in RDAP is UTF-8 |
| 3561 |
[<a href="./rfc3629" title=""UTF-8, a transformation format of ISO 10646"">RFC3629</a>], and all servers and clients MUST support UTF-8. |
| 3562 |
|
| 3563 |
<span class="h3"><a class="selflink" id="section-12.2" href="#section-12.2">12.2</a>. URIs and IRIs</span> |
| 3564 |
|
| 3565 |
[<a id="ref-RFC7480">RFC7480</a>] defines the use of URIs and IRIs in RDAP. |
| 3566 |
|
| 3567 |
<span class="h3"><a class="selflink" id="section-12.3" href="#section-12.3">12.3</a>. Language Tags</span> |
| 3568 |
|
| 3569 |
<a href="#section-4.4">Section 4.4</a> defines the use of language tags in the JSON responses |
| 3570 |
defined in this document. |
| 3571 |
|
| 3572 |
|
| 3573 |
|
| 3574 |
|
| 3575 |
|
| 3576 |
|
| 3577 |
|
| 3578 |
|
| 3579 |
|
| 3580 |
<span class="grey">Newton & Hollenbeck Standards Track [Page 64]</span></pre> |
| 3581 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-65" ></span> |
| 3582 |
<span class="grey"><a href="./rfc7483">RFC 7483</a> RDAP JSON Responses March 2015</span> |
| 3583 |
|
| 3584 |
|
| 3585 |
<span class="h3"><a class="selflink" id="section-12.4" href="#section-12.4">12.4</a>. Internationalized Domain Names</span> |
| 3586 |
|
| 3587 |
IDNs are denoted in this specification by the separation of DNS names |
| 3588 |
in LDH form and Unicode form (see <a href="#section-3">Section 3</a>). Representation of IDNs |
| 3589 |
in registries is described by the "variants" object in <a href="#section-5.3">Section 5.3</a> |
| 3590 |
and the suggested values listed in <a href="#section-10.2.5">Section 10.2.5</a>. |
| 3591 |
|
| 3592 |
<span class="h2"><a class="selflink" id="section-13" href="#section-13">13</a>. Privacy Considerations</span> |
| 3593 |
|
| 3594 |
This specification suggests status values to denote contact and |
| 3595 |
registrant information that has been marked as private and/or has |
| 3596 |
been removed or obscured. See <a href="#section-10.2.2">Section 10.2.2</a> for the complete list |
| 3597 |
of status values. A few of the status values indicate that there are |
| 3598 |
privacy concerns associated with the object instance. The following |
| 3599 |
status codes SHOULD be used to describe data elements of a response |
| 3600 |
when appropriate: |
| 3601 |
|
| 3602 |
private -- The object is not be shared in query responses, unless |
| 3603 |
the user is authorized to view this information. |
| 3604 |
|
| 3605 |
removed -- Data elements within the object have been collected but |
| 3606 |
have been omitted from the response. This option can be used to |
| 3607 |
prevent unauthorized access to associated object instances without |
| 3608 |
the need to mark them as private. |
| 3609 |
|
| 3610 |
obscured -- Data elements within the object have been collected, |
| 3611 |
but the response value has been altered so that values are not |
| 3612 |
easily discernible. A value changed from "1212" to "XXXX" is an |
| 3613 |
example of obscured data. This option may reveal privacy |
| 3614 |
sensitive information and should only be used when data |
| 3615 |
sensitivity does not require a more protective option like |
| 3616 |
"private" or "removed". |
| 3617 |
|
| 3618 |
See <a href="#appendix-A.1">Appendix A.1</a> for an example of applying those values to contacts |
| 3619 |
and registrants. |
| 3620 |
|
| 3621 |
<span class="h2"><a class="selflink" id="section-14" href="#section-14">14</a>. References</span> |
| 3622 |
|
| 3623 |
<span class="h3"><a class="selflink" id="section-14.1" href="#section-14.1">14.1</a>. Normative References</span> |
| 3624 |
|
| 3625 |
[<a id="ref-ISO.3166.1988">ISO.3166.1988</a>] |
| 3626 |
International Organization for Standardization, "Codes for |
| 3627 |
the representation of names of countries, 3rd edition", |
| 3628 |
ISO Standard 3166, August 1988. |
| 3629 |
|
| 3630 |
[<a id="ref-RFC2119">RFC2119</a>] Bradner, S., "Key words for use in RFCs to Indicate |
| 3631 |
Requirement Levels", <a href="https://www.rfc-editor.org/bcp/bcp14">BCP 14</a>, <a href="./rfc2119">RFC 2119</a>, March 1997, |
| 3632 |
<<a href="http://www.rfc-editor.org/info/rfc2119">http://www.rfc-editor.org/info/rfc2119</a>>. |
| 3633 |
|
| 3634 |
|
| 3635 |
|
| 3636 |
<span class="grey">Newton & Hollenbeck Standards Track [Page 65]</span></pre> |
| 3637 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-66" ></span> |
| 3638 |
<span class="grey"><a href="./rfc7483">RFC 7483</a> RDAP JSON Responses March 2015</span> |
| 3639 |
|
| 3640 |
|
| 3641 |
[<a id="ref-RFC3339">RFC3339</a>] Klyne, G., Ed. and C. Newman, "Date and Time on the |
| 3642 |
Internet: Timestamps", <a href="./rfc3339">RFC 3339</a>, July 2002, |
| 3643 |
<<a href="http://www.rfc-editor.org/info/rfc3339">http://www.rfc-editor.org/info/rfc3339</a>>. |
| 3644 |
|
| 3645 |
[<a id="ref-RFC3629">RFC3629</a>] Yergeau, F., "UTF-8, a transformation format of ISO |
| 3646 |
10646", STD 63, <a href="./rfc3629">RFC 3629</a>, November 2003, |
| 3647 |
<<a href="http://www.rfc-editor.org/info/rfc3629">http://www.rfc-editor.org/info/rfc3629</a>>. |
| 3648 |
|
| 3649 |
[<a id="ref-RFC3986">RFC3986</a>] Berners-Lee, T., Fielding, R., and L. Masinter, "Uniform |
| 3650 |
Resource Identifier (URI): Generic Syntax", STD 66, <a href="./rfc3986">RFC</a> |
| 3651 |
<a href="./rfc3986">3986</a>, January 2005, |
| 3652 |
<<a href="http://www.rfc-editor.org/info/rfc3986">http://www.rfc-editor.org/info/rfc3986</a>>. |
| 3653 |
|
| 3654 |
[<a id="ref-RFC4034">RFC4034</a>] Arends, R., Austein, R., Larson, M., Massey, D., and S. |
| 3655 |
Rose, "Resource Records for the DNS Security Extensions", |
| 3656 |
<a href="./rfc4034">RFC 4034</a>, March 2005, |
| 3657 |
<<a href="http://www.rfc-editor.org/info/rfc4034">http://www.rfc-editor.org/info/rfc4034</a>>. |
| 3658 |
|
| 3659 |
[<a id="ref-RFC5226">RFC5226</a>] Narten, T. and H. Alvestrand, "Guidelines for Writing an |
| 3660 |
IANA Considerations Section in RFCs", <a href="https://www.rfc-editor.org/bcp/bcp26">BCP 26</a>, <a href="./rfc5226">RFC 5226</a>, |
| 3661 |
May 2008, <<a href="http://www.rfc-editor.org/info/rfc5226">http://www.rfc-editor.org/info/rfc5226</a>>. |
| 3662 |
|
| 3663 |
[<a id="ref-RFC5396">RFC5396</a>] Huston, G. and G. Michaelson, "Textual Representation of |
| 3664 |
Autonomous System (AS) Numbers", <a href="./rfc5396">RFC 5396</a>, December 2008, |
| 3665 |
<<a href="http://www.rfc-editor.org/info/rfc5396">http://www.rfc-editor.org/info/rfc5396</a>>. |
| 3666 |
|
| 3667 |
[<a id="ref-RFC5646">RFC5646</a>] Phillips, A. and M. Davis, "Tags for Identifying |
| 3668 |
Languages", <a href="https://www.rfc-editor.org/bcp/bcp47">BCP 47</a>, <a href="./rfc5646">RFC 5646</a>, September 2009, |
| 3669 |
<<a href="http://www.rfc-editor.org/info/rfc5646">http://www.rfc-editor.org/info/rfc5646</a>>. |
| 3670 |
|
| 3671 |
[<a id="ref-RFC5890">RFC5890</a>] Klensin, J., "Internationalized Domain Names for |
| 3672 |
Applications (IDNA): Definitions and Document Framework", |
| 3673 |
<a href="./rfc5890">RFC 5890</a>, August 2010, |
| 3674 |
<<a href="http://www.rfc-editor.org/info/rfc5890">http://www.rfc-editor.org/info/rfc5890</a>>. |
| 3675 |
|
| 3676 |
[<a id="ref-RFC5952">RFC5952</a>] Kawamura, S. and M. Kawashima, "A Recommendation for IPv6 |
| 3677 |
Address Text Representation", <a href="./rfc5952">RFC 5952</a>, August 2010, |
| 3678 |
<<a href="http://www.rfc-editor.org/info/rfc5952">http://www.rfc-editor.org/info/rfc5952</a>>. |
| 3679 |
|
| 3680 |
[<a id="ref-RFC5988">RFC5988</a>] Nottingham, M., "Web Linking", <a href="./rfc5988">RFC 5988</a>, October 2010, |
| 3681 |
<<a href="http://www.rfc-editor.org/info/rfc5988">http://www.rfc-editor.org/info/rfc5988</a>>. |
| 3682 |
|
| 3683 |
[<a id="ref-RFC7095">RFC7095</a>] Kewisch, P., "jCard: The JSON Format for vCard", <a href="./rfc7095">RFC 7095</a>, |
| 3684 |
January 2014, <<a href="http://www.rfc-editor.org/info/rfc7095">http://www.rfc-editor.org/info/rfc7095</a>>. |
| 3685 |
|
| 3686 |
[<a id="ref-RFC7159">RFC7159</a>] Bray, T., "The JavaScript Object Notation (JSON) Data |
| 3687 |
Interchange Format", <a href="./rfc7159">RFC 7159</a>, March 2014, |
| 3688 |
<<a href="http://www.rfc-editor.org/info/rfc7159">http://www.rfc-editor.org/info/rfc7159</a>>. |
| 3689 |
|
| 3690 |
|
| 3691 |
|
| 3692 |
<span class="grey">Newton & Hollenbeck Standards Track [Page 66]</span></pre> |
| 3693 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-67" ></span> |
| 3694 |
<span class="grey"><a href="./rfc7483">RFC 7483</a> RDAP JSON Responses March 2015</span> |
| 3695 |
|
| 3696 |
|
| 3697 |
[<a id="ref-RFC7480">RFC7480</a>] Newton, A., Ellacott, B., and N. Kong, "HTTP Usage in the |
| 3698 |
Registration Data Access Protocol (RDAP)", <a href="./rfc7480">RFC 7480</a>, March |
| 3699 |
2015, <<a href="http://www.rfc-editor.org/info/rfc7480">http://www.rfc-editor.org/info/rfc7480</a>>. |
| 3700 |
|
| 3701 |
[<a id="ref-RFC7481">RFC7481</a>] Hollenbeck, S. and N. Kong, "Security Services for the |
| 3702 |
Registration Data Access Protocol (RDAP)", <a href="./rfc7481">RFC 7481</a>, March |
| 3703 |
2015, <<a href="http://www.rfc-editor.org/info/rfc7481">http://www.rfc-editor.org/info/rfc7481</a>>. |
| 3704 |
|
| 3705 |
[<a id="ref-RFC7482">RFC7482</a>] Newton, A. and S. Hollenbeck, "Registration Data Access |
| 3706 |
Protocol (RDAP) Query Format", <a href="./rfc7482">RFC 7482</a>, March 2015, |
| 3707 |
<<a href="http://www.rfc-editor.org/info/rfc7482">http://www.rfc-editor.org/info/rfc7482</a>>. |
| 3708 |
|
| 3709 |
<span class="h3"><a class="selflink" id="section-14.2" href="#section-14.2">14.2</a>. Informative References</span> |
| 3710 |
|
| 3711 |
[<a id="ref-IANA_IDNTABLES">IANA_IDNTABLES</a>] |
| 3712 |
IANA, "Repository of IDN Practices", |
| 3713 |
<<a href="http://www.iana.org/domains/idn-tables">http://www.iana.org/domains/idn-tables</a>>. |
| 3714 |
|
| 3715 |
[<a id="ref-JSON_ascendancy">JSON_ascendancy</a>] |
| 3716 |
MacVittie, L., "The Stealthy Ascendancy of JSON", April |
| 3717 |
2011, <<a href="https://devcentral.f5.com/weblogs/macvittie/archive/2011/04/27/the-stealthy-ascendancy-of-json.aspx">https://devcentral.f5.com/weblogs/macvittie/</a> |
| 3718 |
<a href="https://devcentral.f5.com/weblogs/macvittie/archive/2011/04/27/the-stealthy-ascendancy-of-json.aspx">archive/2011/04/27/the-stealthy-ascendancy-of-json.aspx</a>>. |
| 3719 |
|
| 3720 |
[<a id="ref-JSON_performance_study">JSON_performance_study</a>] |
| 3721 |
Nurseitov, N., Paulson, M., Reynolds, R., and C. Izurieta, |
| 3722 |
"Comparison of JSON and XML Data Interchange Formats: A |
| 3723 |
Case Study", 2009, |
| 3724 |
<<a href="http://www.cs.montana.edu/izurieta/pubs/caine2009.pdf">http://www.cs.montana.edu/izurieta/pubs/caine2009.pdf</a>>. |
| 3725 |
|
| 3726 |
[<a id="ref-RFC3912">RFC3912</a>] Daigle, L., "WHOIS Protocol Specification", <a href="./rfc3912">RFC 3912</a>, |
| 3727 |
September 2004, <<a href="http://www.rfc-editor.org/info/rfc3912">http://www.rfc-editor.org/info/rfc3912</a>>. |
| 3728 |
|
| 3729 |
[<a id="ref-RFC5730">RFC5730</a>] Hollenbeck, S., "Extensible Provisioning Protocol (EPP)", |
| 3730 |
STD 69, <a href="./rfc5730">RFC 5730</a>, August 2009, |
| 3731 |
<<a href="http://www.rfc-editor.org/info/rfc5730">http://www.rfc-editor.org/info/rfc5730</a>>. |
| 3732 |
|
| 3733 |
[<a id="ref-RFC5910">RFC5910</a>] Gould, J. and S. Hollenbeck, "Domain Name System (DNS) |
| 3734 |
Security Extensions Mapping for the Extensible |
| 3735 |
Provisioning Protocol (EPP)", <a href="./rfc5910">RFC 5910</a>, May 2010, |
| 3736 |
<<a href="http://www.rfc-editor.org/info/rfc5910">http://www.rfc-editor.org/info/rfc5910</a>>. |
| 3737 |
|
| 3738 |
[<a id="ref-RFC6350">RFC6350</a>] Perreault, S., "vCard Format Specification", <a href="./rfc6350">RFC 6350</a>, |
| 3739 |
August 2011, <<a href="http://www.rfc-editor.org/info/rfc6350">http://www.rfc-editor.org/info/rfc6350</a>>. |
| 3740 |
|
| 3741 |
[<a id="ref-RFC6839">RFC6839</a>] Hansen, T. and A. Melnikov, "Additional Media Type |
| 3742 |
Structured Syntax Suffixes", <a href="./rfc6839">RFC 6839</a>, January 2013, |
| 3743 |
<<a href="http://www.rfc-editor.org/info/rfc6839">http://www.rfc-editor.org/info/rfc6839</a>>. |
| 3744 |
|
| 3745 |
|
| 3746 |
|
| 3747 |
|
| 3748 |
<span class="grey">Newton & Hollenbeck Standards Track [Page 67]</span></pre> |
| 3749 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-68" ></span> |
| 3750 |
<span class="grey"><a href="./rfc7483">RFC 7483</a> RDAP JSON Responses March 2015</span> |
| 3751 |
|
| 3752 |
|
| 3753 |
<span class="h2"><a class="selflink" id="appendix-A" href="#appendix-A">Appendix A</a>. Suggested Data Modeling with the Entity Object Class</span> |
| 3754 |
|
| 3755 |
<span class="h3"><a class="selflink" id="appendix-A.1" href="#appendix-A.1">A.1</a>. Registrants and Contacts</span> |
| 3756 |
|
| 3757 |
This document does not provide specific object classes for |
| 3758 |
registrants and contacts. Instead, the entity object class may be |
| 3759 |
used to represent a registrant or contact. When the entity object is |
| 3760 |
embedded inside a containing object such as a domain name or IP |
| 3761 |
network, the "roles" string array can be used to signify the |
| 3762 |
relationship. It is recommended that the values from <a href="#section-10.2.4">Section 10.2.4</a> |
| 3763 |
be used. |
| 3764 |
|
| 3765 |
The following is an example of an elided containing object with an |
| 3766 |
embedded entity that is both a registrant and administrative contact: |
| 3767 |
|
| 3768 |
{ |
| 3769 |
... |
| 3770 |
"entities" : |
| 3771 |
[ |
| 3772 |
{ |
| 3773 |
"objectClassName" : "entity", |
| 3774 |
"handle" : "XXXX", |
| 3775 |
"vcardArray":[ |
| 3776 |
"vcard", |
| 3777 |
[ |
| 3778 |
["version", {}, "text", "4.0"], |
| 3779 |
["fn", {}, "text", "Joe User"], |
| 3780 |
["kind", {}, "text", "individual"], |
| 3781 |
["lang", { |
| 3782 |
"pref":"1" |
| 3783 |
}, "language-tag", "fr"], |
| 3784 |
["lang", { |
| 3785 |
"pref":"2" |
| 3786 |
}, "language-tag", "en"], |
| 3787 |
["org", { |
| 3788 |
"type":"work" |
| 3789 |
}, "text", "Example"], |
| 3790 |
["title", {}, "text", "Research Scientist"], |
| 3791 |
["role", {}, "text", "Project Lead"], |
| 3792 |
["adr", |
| 3793 |
{ "type":"work" }, |
| 3794 |
"text", |
| 3795 |
[ |
| 3796 |
"", |
| 3797 |
"Suite 1234", |
| 3798 |
"4321 Rue Somewhere", |
| 3799 |
"Quebec", |
| 3800 |
"QC", |
| 3801 |
|
| 3802 |
|
| 3803 |
|
| 3804 |
<span class="grey">Newton & Hollenbeck Standards Track [Page 68]</span></pre> |
| 3805 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-69" ></span> |
| 3806 |
<span class="grey"><a href="./rfc7483">RFC 7483</a> RDAP JSON Responses March 2015</span> |
| 3807 |
|
| 3808 |
|
| 3809 |
"G1V 2M2", |
| 3810 |
"Canada" |
| 3811 |
] |
| 3812 |
], |
| 3813 |
["tel", |
| 3814 |
{ "type":["work", "voice"], "pref":"1" }, |
| 3815 |
"uri", "tel:+1-555-555-1234;ext=102" |
| 3816 |
], |
| 3817 |
["email", |
| 3818 |
{ "type":"work" }, |
| 3819 |
"text", "[email protected]" |
| 3820 |
] |
| 3821 |
] |
| 3822 |
], |
| 3823 |
"roles" : [ "registrant", "administrative" ], |
| 3824 |
"remarks" : |
| 3825 |
[ |
| 3826 |
{ |
| 3827 |
"description" : |
| 3828 |
[ |
| 3829 |
"She sells sea shells down by the sea shore.", |
| 3830 |
"Originally written by Terry Sullivan." |
| 3831 |
] |
| 3832 |
} |
| 3833 |
], |
| 3834 |
"events" : |
| 3835 |
[ |
| 3836 |
{ |
| 3837 |
"eventAction" : "registration", |
| 3838 |
"eventDate" : "1990-12-31T23:59:59Z" |
| 3839 |
}, |
| 3840 |
{ |
| 3841 |
"eventAction" : "last changed", |
| 3842 |
"eventDate" : "1991-12-31T23:59:59Z" |
| 3843 |
} |
| 3844 |
] |
| 3845 |
} |
| 3846 |
] |
| 3847 |
} |
| 3848 |
|
| 3849 |
Figure 34 |
| 3850 |
|
| 3851 |
In many use cases, it is necessary to hide or obscure the information |
| 3852 |
of a registrant or contact due to policy or other operational |
| 3853 |
matters. Registries can denote these situations with "status" values |
| 3854 |
(see <a href="#section-10.2.2">Section 10.2.2</a>). |
| 3855 |
|
| 3856 |
|
| 3857 |
|
| 3858 |
|
| 3859 |
|
| 3860 |
<span class="grey">Newton & Hollenbeck Standards Track [Page 69]</span></pre> |
| 3861 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-70" ></span> |
| 3862 |
<span class="grey"><a href="./rfc7483">RFC 7483</a> RDAP JSON Responses March 2015</span> |
| 3863 |
|
| 3864 |
|
| 3865 |
The following is an elided example of a registrant with information |
| 3866 |
changed to reflect that of a third party. |
| 3867 |
|
| 3868 |
{ |
| 3869 |
... |
| 3870 |
"entities" : |
| 3871 |
[ |
| 3872 |
{ |
| 3873 |
"objectClassName" : "entity", |
| 3874 |
"handle" : "XXXX", |
| 3875 |
... |
| 3876 |
"roles" : [ "registrant", "administrative" ], |
| 3877 |
"status" : [ "proxy", "private", "obscured" ] |
| 3878 |
} |
| 3879 |
] |
| 3880 |
} |
| 3881 |
|
| 3882 |
Figure 35 |
| 3883 |
|
| 3884 |
<span class="h3"><a class="selflink" id="appendix-A.2" href="#appendix-A.2">A.2</a>. Registrars</span> |
| 3885 |
|
| 3886 |
This document does not provide a specific object class for |
| 3887 |
registrars, but like registrants and contacts (see <a href="#appendix-A.1">Appendix A.1</a>), the |
| 3888 |
"roles" string array maybe used. Additionally, many registrars have |
| 3889 |
publicly assigned identifiers. The publicIds structure (<a href="#section-4.8">Section 4.8</a>) |
| 3890 |
represents that information. |
| 3891 |
|
| 3892 |
The following is an example of an elided containing object with an |
| 3893 |
embedded entity that is a registrar: |
| 3894 |
|
| 3895 |
{ |
| 3896 |
... |
| 3897 |
"entities":[ |
| 3898 |
{ |
| 3899 |
"objectClassName" : "entity", |
| 3900 |
"handle":"XXXX", |
| 3901 |
"vcardArray":[ |
| 3902 |
"vcard", |
| 3903 |
[ |
| 3904 |
["version", {}, "text", "4.0"], |
| 3905 |
["fn", {}, "text", "Joe's Fish, Chips, and Domains"], |
| 3906 |
["kind", {}, "text", "org"], |
| 3907 |
["lang", { |
| 3908 |
"pref":"1" |
| 3909 |
}, "language-tag", "fr"], |
| 3910 |
["lang", { |
| 3911 |
"pref":"2" |
| 3912 |
}, "language-tag", "en"], |
| 3913 |
|
| 3914 |
|
| 3915 |
|
| 3916 |
<span class="grey">Newton & Hollenbeck Standards Track [Page 70]</span></pre> |
| 3917 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-71" ></span> |
| 3918 |
<span class="grey"><a href="./rfc7483">RFC 7483</a> RDAP JSON Responses March 2015</span> |
| 3919 |
|
| 3920 |
|
| 3921 |
["org", { |
| 3922 |
"type":"work" |
| 3923 |
}, "text", "Example"], |
| 3924 |
["adr", |
| 3925 |
{ "type":"work" }, |
| 3926 |
"text", |
| 3927 |
[ |
| 3928 |
"", |
| 3929 |
"Suite 1234", |
| 3930 |
"4321 Rue Somewhere", |
| 3931 |
"Quebec", |
| 3932 |
"QC", |
| 3933 |
"G1V 2M2", |
| 3934 |
"Canada" |
| 3935 |
] |
| 3936 |
], |
| 3937 |
["tel", |
| 3938 |
{ |
| 3939 |
"type":["work", "voice"], |
| 3940 |
"pref":"1" |
| 3941 |
}, |
| 3942 |
"uri", "tel:+1-555-555-1234;ext=102" |
| 3943 |
], |
| 3944 |
["email", |
| 3945 |
{ "type":"work" }, |
| 3946 |
"text", "[email protected]" |
| 3947 |
] |
| 3948 |
] |
| 3949 |
], |
| 3950 |
"roles":[ "registrar" ], |
| 3951 |
"publicIds":[ |
| 3952 |
{ |
| 3953 |
"type":"IANA Registrar ID", |
| 3954 |
"identifier":"1" |
| 3955 |
} |
| 3956 |
], |
| 3957 |
"remarks":[ |
| 3958 |
{ |
| 3959 |
"description":[ |
| 3960 |
"She sells sea shells down by the sea shore.", |
| 3961 |
"Originally written by Terry Sullivan." |
| 3962 |
] |
| 3963 |
} |
| 3964 |
], |
| 3965 |
"links":[ |
| 3966 |
{ |
| 3967 |
"value":"http://example.net/entity/XXXX", |
| 3968 |
"rel":"alternate", |
| 3969 |
|
| 3970 |
|
| 3971 |
|
| 3972 |
<span class="grey">Newton & Hollenbeck Standards Track [Page 71]</span></pre> |
| 3973 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-72" ></span> |
| 3974 |
<span class="grey"><a href="./rfc7483">RFC 7483</a> RDAP JSON Responses March 2015</span> |
| 3975 |
|
| 3976 |
|
| 3977 |
"type":"text/html", |
| 3978 |
"href":"http://www.example.com" |
| 3979 |
} |
| 3980 |
] |
| 3981 |
} |
| 3982 |
] |
| 3983 |
} |
| 3984 |
|
| 3985 |
Figure 36 |
| 3986 |
|
| 3987 |
<span class="h2"><a class="selflink" id="appendix-B" href="#appendix-B">Appendix B</a>. Modeling Events</span> |
| 3988 |
|
| 3989 |
Events represent actions that have taken place against a registered |
| 3990 |
object at a certain date and time. Events have three properties: the |
| 3991 |
action, the actor, and the date and time of the event (which is |
| 3992 |
sometimes in the future). In some cases, the identity of the actor |
| 3993 |
is not captured. |
| 3994 |
|
| 3995 |
Events can be modeled in three ways: |
| 3996 |
|
| 3997 |
1. events with no designated actor |
| 3998 |
|
| 3999 |
2. events where the actor is only designated by an identifier |
| 4000 |
|
| 4001 |
3. events where the actor can be modeled as an entity |
| 4002 |
|
| 4003 |
For the first use case, the events data structure (<a href="#section-4.5">Section 4.5</a>) is |
| 4004 |
used without the "eventActor" object member. |
| 4005 |
|
| 4006 |
This is an example of an "events" array without the "eventActor". |
| 4007 |
|
| 4008 |
"events" : |
| 4009 |
[ |
| 4010 |
{ |
| 4011 |
"eventAction" : "registration", |
| 4012 |
"eventDate" : "1990-12-31T23:59:59Z" |
| 4013 |
} |
| 4014 |
] |
| 4015 |
|
| 4016 |
Figure 37 |
| 4017 |
|
| 4018 |
For the second use case, the events data structure (<a href="#section-4.5">Section 4.5</a>) is |
| 4019 |
used with the "eventActor" object member. |
| 4020 |
|
| 4021 |
|
| 4022 |
|
| 4023 |
|
| 4024 |
|
| 4025 |
|
| 4026 |
|
| 4027 |
|
| 4028 |
<span class="grey">Newton & Hollenbeck Standards Track [Page 72]</span></pre> |
| 4029 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-73" ></span> |
| 4030 |
<span class="grey"><a href="./rfc7483">RFC 7483</a> RDAP JSON Responses March 2015</span> |
| 4031 |
|
| 4032 |
|
| 4033 |
This is an example of an "events" array with the "eventActor". |
| 4034 |
|
| 4035 |
"events" : |
| 4036 |
[ |
| 4037 |
{ |
| 4038 |
"eventAction" : "registration", |
| 4039 |
"eventActor" : "XYZ-NIC", |
| 4040 |
"eventDate" : "1990-12-31T23:59:59Z" |
| 4041 |
} |
| 4042 |
] |
| 4043 |
|
| 4044 |
Figure 38 |
| 4045 |
|
| 4046 |
For the third use case, the "asEventActor" array is used when an |
| 4047 |
entity (<a href="#section-5.1">Section 5.1</a>) is embedded into another object class. The |
| 4048 |
"asEventActor" array follows the same structure as the "events" array |
| 4049 |
but does not have "eventActor" attributes. |
| 4050 |
|
| 4051 |
The following is an elided example of a domain object with an entity |
| 4052 |
as an event actor. |
| 4053 |
|
| 4054 |
{ |
| 4055 |
"objectClassName" : "domain", |
| 4056 |
"handle" : "XXXX", |
| 4057 |
"ldhName" : "foo.example", |
| 4058 |
"status" : [ "locked", "transfer prohibited" ], |
| 4059 |
... |
| 4060 |
"entities" : |
| 4061 |
[ |
| 4062 |
{ |
| 4063 |
"handle" : "XXXX", |
| 4064 |
... |
| 4065 |
"asEventActor" : |
| 4066 |
[ |
| 4067 |
{ |
| 4068 |
"eventAction" : "last changed", |
| 4069 |
"eventDate" : "1990-12-31T23:59:59Z" |
| 4070 |
} |
| 4071 |
] |
| 4072 |
} |
| 4073 |
] |
| 4074 |
} |
| 4075 |
|
| 4076 |
Figure 39 |
| 4077 |
|
| 4078 |
|
| 4079 |
|
| 4080 |
|
| 4081 |
|
| 4082 |
|
| 4083 |
|
| 4084 |
<span class="grey">Newton & Hollenbeck Standards Track [Page 73]</span></pre> |
| 4085 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-74" ></span> |
| 4086 |
<span class="grey"><a href="./rfc7483">RFC 7483</a> RDAP JSON Responses March 2015</span> |
| 4087 |
|
| 4088 |
|
| 4089 |
<span class="h2"><a class="selflink" id="appendix-C" href="#appendix-C">Appendix C</a>. Structured vs. Unstructured Addresses</span> |
| 4090 |
|
| 4091 |
The entity (<a href="#section-5.1">Section 5.1</a>) object class uses jCard [<a href="./rfc7095" title=""jCard: The JSON Format for vCard"">RFC7095</a>] to |
| 4092 |
represent contact information, including postal addresses. jCard has |
| 4093 |
the ability to represent multiple language preferences, multiple |
| 4094 |
email address and phone numbers, and multiple postal addresses in |
| 4095 |
both a structured and unstructured format. This section describes |
| 4096 |
the use of jCard for representing structured and unstructured |
| 4097 |
addresses. |
| 4098 |
|
| 4099 |
The following is an example of a jCard. |
| 4100 |
|
| 4101 |
{ |
| 4102 |
"vcardArray":[ |
| 4103 |
"vcard", |
| 4104 |
[ |
| 4105 |
["version", {}, "text", "4.0"], |
| 4106 |
["fn", {}, "text", "Joe User"], |
| 4107 |
["n", {}, "text", |
| 4108 |
["User", "Joe", "", "", ["ing. jr", "M.Sc."]] |
| 4109 |
], |
| 4110 |
["kind", {}, "text", "individual"], |
| 4111 |
["lang", { |
| 4112 |
"pref":"1" |
| 4113 |
}, "language-tag", "fr"], |
| 4114 |
["lang", { |
| 4115 |
"pref":"2" |
| 4116 |
}, "language-tag", "en"], |
| 4117 |
["org", { |
| 4118 |
"type":"work" |
| 4119 |
}, "text", "Example"], |
| 4120 |
["title", {}, "text", "Research Scientist"], |
| 4121 |
["role", {}, "text", "Project Lead"], |
| 4122 |
["adr", |
| 4123 |
{ "type":"work" }, |
| 4124 |
"text", |
| 4125 |
[ |
| 4126 |
"", |
| 4127 |
"Suite 1234", |
| 4128 |
"4321 Rue Somewhere", |
| 4129 |
"Quebec", |
| 4130 |
"QC", |
| 4131 |
"G1V 2M2", |
| 4132 |
"Canada" |
| 4133 |
] |
| 4134 |
], |
| 4135 |
["adr", |
| 4136 |
{ |
| 4137 |
|
| 4138 |
|
| 4139 |
|
| 4140 |
<span class="grey">Newton & Hollenbeck Standards Track [Page 74]</span></pre> |
| 4141 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-75" ></span> |
| 4142 |
<span class="grey"><a href="./rfc7483">RFC 7483</a> RDAP JSON Responses March 2015</span> |
| 4143 |
|
| 4144 |
|
| 4145 |
"type":"home", |
| 4146 |
"label":"123 Maple Ave\nSuite 90001\nVancouver\nBC\n1239\n" |
| 4147 |
}, |
| 4148 |
"text", |
| 4149 |
[ |
| 4150 |
"", "", "", "", "", "", "" |
| 4151 |
] |
| 4152 |
], |
| 4153 |
["tel", |
| 4154 |
{ "type":["work", "voice"], "pref":"1" }, |
| 4155 |
"uri", "tel:+1-555-555-1234;ext=102" |
| 4156 |
], |
| 4157 |
["tel", |
| 4158 |
{ |
| 4159 |
"type":["work", "cell", "voice", "video", "text"] |
| 4160 |
}, |
| 4161 |
"uri", |
| 4162 |
"tel:+1-555-555-1234" |
| 4163 |
], |
| 4164 |
["email", |
| 4165 |
{ "type":"work" }, |
| 4166 |
"text", "[email protected]" |
| 4167 |
], |
| 4168 |
["geo", { |
| 4169 |
"type":"work" |
| 4170 |
}, "uri", "geo:46.772673,-71.282945"], |
| 4171 |
["key", |
| 4172 |
{ "type":"work" }, |
| 4173 |
"uri", "http://www.example.com/joe.user/joe.asc" |
| 4174 |
], |
| 4175 |
["tz", {}, |
| 4176 |
"utc-offset", "-05:00"], |
| 4177 |
["url", { "type":"home" }, |
| 4178 |
"uri", "http://example.org"] |
| 4179 |
] |
| 4180 |
] |
| 4181 |
} |
| 4182 |
|
| 4183 |
Figure 40 |
| 4184 |
|
| 4185 |
The arrays in Figure 40 with the first member of "adr" represent |
| 4186 |
postal addresses. In the first example, the postal address is given |
| 4187 |
as an array of strings and constitutes a structured address. For |
| 4188 |
components of the structured address that are not applicable, an |
| 4189 |
empty string is given. Each member of that array aligns with the |
| 4190 |
positions of a vCard as given in [<a href="./rfc6350" title=""vCard Format Specification"">RFC6350</a>]. In this example, the |
| 4191 |
following data corresponds to the following positional meanings: |
| 4192 |
|
| 4193 |
|
| 4194 |
|
| 4195 |
|
| 4196 |
<span class="grey">Newton & Hollenbeck Standards Track [Page 75]</span></pre> |
| 4197 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-76" ></span> |
| 4198 |
<span class="grey"><a href="./rfc7483">RFC 7483</a> RDAP JSON Responses March 2015</span> |
| 4199 |
|
| 4200 |
|
| 4201 |
1. post office box -- not applicable; empty string |
| 4202 |
|
| 4203 |
2. extended address (e.g., apartment or suite number) -- Suite 1234 |
| 4204 |
|
| 4205 |
3. street address -- 4321 Rue Somewhere |
| 4206 |
|
| 4207 |
4. locality (e.g., city) -- Quebec |
| 4208 |
|
| 4209 |
5. region (e.g., state or province) -- QC |
| 4210 |
|
| 4211 |
6. postal code -- G1V 2M2 |
| 4212 |
|
| 4213 |
7. country name (full name) -- Canada |
| 4214 |
|
| 4215 |
The second example is an unstructured address. It uses the label |
| 4216 |
attribute, which is a string containing a newline (\n) character to |
| 4217 |
separate address components in an unordered, unspecified manner. |
| 4218 |
Note that in this example, the structured address array is still |
| 4219 |
given but that each string is an empty string. |
| 4220 |
|
| 4221 |
<span class="h2"><a class="selflink" id="appendix-D" href="#appendix-D">Appendix D</a>. Secure DNS</span> |
| 4222 |
|
| 4223 |
<a href="#section-5.3">Section 5.3</a> defines the "secureDNS" member to represent secure DNS |
| 4224 |
information about domain names. |
| 4225 |
|
| 4226 |
DNSSEC provides data integrity for DNS through the digital signing of |
| 4227 |
resource records. To enable DNSSEC, the zone is signed by one or |
| 4228 |
more private keys and the signatures are stored as RRSIG records. To |
| 4229 |
complete the chain of trust in the DNS zone hierarchy, a digest of |
| 4230 |
each DNSKEY record (which contains the public key) must be loaded |
| 4231 |
into the parent zone, stored as DS records, and signed by the |
| 4232 |
parent's private key (RRSIG DS record), as indicated in "Resource |
| 4233 |
Records for the DNS Security Extensions" [<a href="./rfc4034" title=""Resource Records for the DNS Security Extensions"">RFC4034</a>]. Creating the DS |
| 4234 |
records in the parent zone can be done by the registration authority |
| 4235 |
"Domain Name System (DNS) Security Extensions Mapping for the |
| 4236 |
Extensible Provisioning Protocol (EPP)" [<a href="./rfc5910" title=""Domain Name System (DNS) Security Extensions Mapping for the Extensible Provisioning Protocol (EPP)"">RFC5910</a>]. |
| 4237 |
|
| 4238 |
Only DS-related information is provided by RDAP, since other |
| 4239 |
information is not generally stored in the registration database. |
| 4240 |
Other DNSSEC-related information can be retrieved with other DNS |
| 4241 |
tools such as dig. |
| 4242 |
|
| 4243 |
The domain object class (<a href="#section-5.3">Section 5.3</a>) can represent this information |
| 4244 |
using either the "dsData" or "keyData" object arrays. Client |
| 4245 |
implementers should be aware that some registries do not collect or |
| 4246 |
do not publish all of the secure DNS meta-information. |
| 4247 |
|
| 4248 |
|
| 4249 |
|
| 4250 |
|
| 4251 |
|
| 4252 |
<span class="grey">Newton & Hollenbeck Standards Track [Page 76]</span></pre> |
| 4253 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-77" ></span> |
| 4254 |
<span class="grey"><a href="./rfc7483">RFC 7483</a> RDAP JSON Responses March 2015</span> |
| 4255 |
|
| 4256 |
|
| 4257 |
<span class="h2"><a class="selflink" id="appendix-E" href="#appendix-E">Appendix E</a>. Motivations for Using JSON</span> |
| 4258 |
|
| 4259 |
This section addresses a common question regarding the use of JSON |
| 4260 |
over other data formats, most notably XML. |
| 4261 |
|
| 4262 |
It is often pointed out that many DNRs and one RIR support the EPP |
| 4263 |
[<a href="./rfc5730" title=""Extensible Provisioning Protocol (EPP)"">RFC5730</a>] standard, which is an XML serialized protocol. The logic |
| 4264 |
is that since EPP is a common protocol in the industry, it follows |
| 4265 |
that XML would be a more natural choice. While EPP does influence |
| 4266 |
this specification quite a bit, EPP serves a different purpose, which |
| 4267 |
is the provisioning of Internet resources between registries and |
| 4268 |
accredited registrars and serving a much narrower audience than that |
| 4269 |
envisioned for RDAP. |
| 4270 |
|
| 4271 |
By contrast, RDAP has a broader audience and is designed for public |
| 4272 |
consumption of data. Experience from RIRs with first generation |
| 4273 |
RESTful web services for WHOIS indicate that a large percentage of |
| 4274 |
clients operate within browsers and other platforms where full-blown |
| 4275 |
XML stacks are not readily available and where JSON is a better fit. |
| 4276 |
|
| 4277 |
Additionally, while EPP is used in much of the DNR community it is |
| 4278 |
not a universal constant in that industry. And finally, EPP's use of |
| 4279 |
XML predates the specification of JSON. If EPP had been defined |
| 4280 |
today, it may very well have used JSON instead of XML. |
| 4281 |
|
| 4282 |
Beyond the specific DNR and RIR communities, the trend in the broader |
| 4283 |
Internet industry is also switching to JSON over XML, especially in |
| 4284 |
the area of RESTful web services (see [<a href="#ref-JSON_ascendancy">JSON_ascendancy</a>]). Studies |
| 4285 |
have also found that JSON is generally less bulky and consequently |
| 4286 |
faster to parse (see [<a href="#ref-JSON_performance_study">JSON_performance_study</a>]). |
| 4287 |
|
| 4288 |
Acknowledgements |
| 4289 |
|
| 4290 |
This document is derived from original work on RIR responses in JSON |
| 4291 |
by Byron J. Ellacott, Arturo L. Servin, Kaveh Ranjbar, and Andrew L. |
| 4292 |
Newton. Additionally, this document incorporates work on DNR |
| 4293 |
responses in JSON by Ning Kong, Linlin Zhou, Jiagui Xie, and Sean |
| 4294 |
Shen. |
| 4295 |
|
| 4296 |
The components of the DNR object classes are derived from a |
| 4297 |
categorization of WHOIS response formats created by Ning Kong, Linlin |
| 4298 |
Zhou, Guangqing Deng, Steve Sheng, Francisco Arias, Ray Bellis, and |
| 4299 |
Frederico Neves. |
| 4300 |
|
| 4301 |
Tom Harrison, Murray Kucherawy, Ed Lewis, Audric Schiltknecht, Naoki |
| 4302 |
Kambe, and Maarten Bosteels contributed significant review comments |
| 4303 |
and provided clarifying text. James Mitchell provided text regarding |
| 4304 |
the processing of unknown JSON attributes and identified issues |
| 4305 |
|
| 4306 |
|
| 4307 |
|
| 4308 |
<span class="grey">Newton & Hollenbeck Standards Track [Page 77]</span></pre> |
| 4309 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-78" ></span> |
| 4310 |
<span class="grey"><a href="./rfc7483">RFC 7483</a> RDAP JSON Responses March 2015</span> |
| 4311 |
|
| 4312 |
|
| 4313 |
leading to the remodeling of events. Ernie Dainow and Francisco |
| 4314 |
Obispo provided concrete suggestions that led to a better variant |
| 4315 |
model for domain names. |
| 4316 |
|
| 4317 |
Ernie Dainow provided the background information on the secure DNS |
| 4318 |
attributes and objects for domains, informative text on DNSSEC, and |
| 4319 |
many other attributes that appear throughout the object classes of |
| 4320 |
this document. |
| 4321 |
|
| 4322 |
The switch to and incorporation of jCard was performed by Simon |
| 4323 |
Perreault. |
| 4324 |
|
| 4325 |
Olaf Kolkman and Murray Kucherawy chaired the IETF's WEIRDS working |
| 4326 |
group from which this document has been created. |
| 4327 |
|
| 4328 |
Authors' Addresses |
| 4329 |
|
| 4330 |
Andrew Lee Newton |
| 4331 |
American Registry for Internet Numbers |
| 4332 |
3635 Concorde Parkway |
| 4333 |
Chantilly, VA 20151 |
| 4334 |
United States |
| 4335 |
|
| 4336 |
EMail: [email protected] |
| 4337 |
URI: <a href="http://www.arin.net">http://www.arin.net</a> |
| 4338 |
|
| 4339 |
|
| 4340 |
Scott Hollenbeck |
| 4341 |
Verisign Labs |
| 4342 |
12061 Bluemont Way |
| 4343 |
Reston, VA 20190 |
| 4344 |
United States |
| 4345 |
|
| 4346 |
EMail: [email protected] |
| 4347 |
URI: <a href="http://www.verisignlabs.com/">http://www.verisignlabs.com/</a> |
| 4348 |
|
| 4349 |
|
| 4350 |
|
| 4351 |
|
| 4352 |
|
| 4353 |
|
| 4354 |
|
| 4355 |
|
| 4356 |
|
| 4357 |
|
| 4358 |
|
| 4359 |
|
| 4360 |
|
| 4361 |
|
| 4362 |
|
| 4363 |
|
| 4364 |
Newton & Hollenbeck Standards Track [Page 78] |
| 4365 |
</pre> |