The following is an elided example of an entity truncated data.

                    
{
  "objectClassName" : "entity",
  "handle" : "ANENTITY",
  "roles" : [ "registrant" ],
  ...
  "entities" : 
  [
    {
      "objectClassName" : "entity",
      "handle": "ANEMBEDDEDENTITY",
      "roles" : [ "technical" ],
      ...
    },
    ...
  ],
  "networks" :
  [
    ...
  ],
  ...  
  "remarks" : 
  [
    {
      "title" : "Data Policy",
      "type" : "object truncated due to unexplainable reason",
      "description" : 
      [
        "Some of the data in this object has been removed."
      ],
      "links" : 
      [
        {
          "value" : "http://example.net/help",
          "rel" : "alternate",
          "type" : "text/html",
          "href" : "http://www.example.com/data_policy.html"
        }
      ]
    }
  ]
}
                    
                

Figure 31

10. IANA Considerations

10.1. RDAP JSON Media Type Registration

This specification registers the "application/rdap+json" media type.

• Type name: application
• Subtype name: rdap+json
• Required parameters: n/a
• Encoding considerations: See section 3.1 of [RFC6839].
• Security considerations: The media represented by this identifier does not have security considerations beyond that found in section 6 of [RFC7159]
• Interoperability considerations: There are no known interoperability problems regarding this media format.
• Published specification: [[ this document ]]
• Applications that use this media type: Implementations of the Registration Data Access Protocol (RDAP)
• Additional information: This media type is a product of the IETF WEIRDS working group. The WEIRDS charter, information on the WEIRDS mailing list, and other documents produced by the WEIRDS working group can be found at https://datatracker.ietf.org/wg/weirds/
• Person & email address to contact for further information: IESG <iesg@ietf.org>
• Intended usage: COMMON
• Restrictions on usage: none
• Author: Andy Newton
• Change controller: IETF
• Provisional Registration: No (upon publication of this RFC)

10.2. JSON Values Registry

This section requests that the IANA create a new category in the protocol registries labeled "Registration Data Access Protocol (RDAP)" (if it does not already exist), and within that category establish a URL referenceable, stand-alone registry labeled "RDAP JSON Values". This new registry is for use in the notices and remarks [notices_and_remarks], status [status], role [entity_object_class], event action [events], and domain variant relation [domain_object_class] fields specified in RDAP.

Each entry in the registry should contain the following fields:

1. Value - the string value being registered.
2. Type - the type of value being registered. It should be one of the following:
   • 'notice or remark type' - denotes a type of notice or remark
   • 'status' - denotes a value for the 'status' object member as defined by Section 4.6.
   • 'role' - denotes a value for the 'role' array as defined in Section 5.1.
   • 'event action' - denotes a value for an event action as defined in Section 4.5.
   • 'domain variant relation' - denotes a relationship between a domain and a domain variant as defined in Section 5.3.

3. Description - a one or two sentence description regarding the meaning of the value, how it might be used, and/or how it should be interpreted by clients.
4. Registrant Name - the name of the person registering the value.
5. Registrant Contact Information - an email address, postal address, or some other information to be used to contact the registrant.

This registry is to be operated under the "Expert Review" policy defined in [RFC5226].

Review of registrations into this registry by the designated expert(s) should be narrowly judged on the following criteria:

1. Values in need of being placed into multiple types must be assigned a separate registration for each type.
2. Values must be strings. They should be multiple words separated by single space characters. Every character should be lowercased. If possible, every word should be given in English and each character should be US ASCII.
3. Registrations should not duplicate the meaning of any existing registration. That is, if a request for a registration is significantly similar in nature to an existing registration, the request should be denied. For example, the terms 'maintainer' and 'registrant' are significantly similar in nature as they both denote a holder of a domain name or Internet number resource. In cases where it may be reasonably argued that machine interpretation of two similar values may alter the operation of client software, designated experts should not judge the values to be of significant similarity.
4. Registrations should be relevant to the common usages of RDAP. Designated experts may rely upon the serving of the value by a DNR or RIR to make this determination.

The following sections provide initial registrations into this registry.

10.2.1. Notice and Remark Types

This section registers the following values into the RDAP JSON Values Registry:

1. • Value: result set truncated due to authorization
   • Type: notice and remark type
   • Description: The list of results does not contain all results due to lack of authorization. This may indicate to some clients that proper authorization will yield a longer result set.
   • Registrant Name: IESG
   • Registrant Contact Information: iesg@ietf.org

2. • Value: result set truncated due to excessive load
   • Type: notice and remark type
   • Description: The list of results does not contain all results due to excessively heavy load on the server. This may indicate to some clients that requerying at a later time will yield a longer result set.
   • Registrant Name: IESG
   • Registrant Contact Information: iesg@ietf.org

3. • Value: result set truncated due to unexplainable reasons
   • Type: notice and remark type
   • Description: The list of results does not contain all results for an unexplainable reason. This may indicate to some clients that requerying for any reason will not yield a longer result set.
   • Registrant Name: IESG
   • Registrant Contact Information: iesg@ietf.org

4. • Value: object truncated due to authorization
   • Type: notice and remark type
   • Description: The object does not contain all data due to lack of authorization.
   • Registrant Name: IESG
   • Registrant Contact Information: iesg@ietf.org

5. • Value: object truncated due to excessive load
   • Type: notice and remark type
   • Description: The object does not contain all data due to excessively heavy load on the server. This may indicate to some clients that requerying at a later time will yield all data of the object.
   • Registrant Name: IESG
   • Registrant Contact Information: iesg@ietf.org

6. • Value: object truncated due to unexplainable reasons
   • Type: notice and remark type
   • Description: The object does not contain all data for an unexplainable reason.
   • Registrant Name: IESG
   • Registrant Contact Information: iesg@ietf.org

10.2.2. Status

This section registers the following values into the RDAP JSON Values Registry:

1. • Value: validated
   • Type: status
   • Description: Signifies that the data of the object instance has been found to be accurate. This type of status is usually found on entity object instances to note the validity of identifying contact information.
   • Registrant Name: IESG
   • Registrant Contact Information: iesg@ietf.org

2. • Value: renew prohibited
   • Type: status
   • Description: Renewal or reregistration of the object instance is forbidden.
   • Registrant Name: IESG
   • Registrant Contact Information: iesg@ietf.org

3. • Value: update prohibited
   • Type: status
   • Description: Updates to the object instance are forbidden.
   • Registrant Name: IESG
   • Registrant Contact Information: iesg@ietf.org

4. • Value: transfer prohibited
   • Type: status
   • Description: Transfers of the registration from one registrar to another are forbidden. This type of status normally applies to DNR domain names.
   • Registrant Name: IESG
   • Registrant Contact Information: iesg@ietf.org

5. • Value: delete prohibited
   • Type: status
   • Description: Deletion of the registration of the object instance is forbidden. This type of status normally applies to DNR domain names.
   • Registrant Name: IESG
   • Registrant Contact Information: iesg@ietf.org

6. • Value: proxy
   • Type: status
   • Description: The registration of the object instance has been performed by a third party. This is most commonly applied to entities.
   • Registrant Name: IESG
   • Registrant Contact Information: iesg@ietf.org

7. • Value: private
   • Type: status
   • Description: The information of the object instance is not designated for public consumption. This is most commonly applied to entities.
   • Registrant Name: IESG
   • Registrant Contact Information: iesg@ietf.org

8. • Value: removed
   • Type: status
   • Description: Some of the information of the object instance has not been made available and has been removed. This is most commonly applied to entities.
   • Registrant Name: IESG
   • Registrant Contact Information: iesg@ietf.org

9. • Value: obscured
   • Type: status
   • Description: Some of the information of the object instance has been altered for the purposes of not readily revealing the actual information of the object instance. This is most commonly applied to entities.
   • Registrant Name: IESG
   • Registrant Contact Information: iesg@ietf.org

10. • Value: associated
    • Type: status
    • Description: The object instance is associated with other object instances in the registry. This is most commonly used to signify that a nameserver is associated with a domain or that an entity is associated with a network resource or domain.
    • Registrant Name: IESG
    • Registrant Contact Information: iesg@ietf.org

11. • Value: active
    • Type: status
    • Description: The object instance is in use. For domain names, it signifies that the domain name is published in DNS. For network and autnum registrations it signifies that they are allocated or assigned for use in operational networks. This maps to the Extensible Provisioning Protocol (EPP) [RFC5730] 'OK' status.
    • Registrant Name: IESG
    • Registrant Contact Information: iesg@ietf.org

12. • Value: inactive
    • Type: status
    • Description: The object instance is not in use. See 'active'.
    • Registrant Name: IESG
    • Registrant Contact Information: iesg@ietf.org

13. • Value: locked
    • Type: status
    • Description: Changes to the object instance cannot be made, including the association of other object instances.
    • Registrant Name: IESG
    • Registrant Contact Information: iesg@ietf.org

14. • Value: pending create
    • Type: status
    • Description: A request has been received for the creation of the object instance but this action is not yet complete.
    • Registrant Name: IESG
    • Registrant Contact Information: iesg@ietf.org

15. • Value: pending renew
    • Type: status
    • Description: A request has been received for the renewal of the object instance but this action is not yet complete.
    • Registrant Name: IESG
    • Registrant Contact Information: iesg@ietf.org

16. • Value: pending transfer
    • Type: status
    • Description: A request has been received for the transfer of the object instance but this action is not yet complete.
    • Registrant Name: IESG
    • Registrant Contact Information: iesg@ietf.org

17. • Value: pending update
    • Type: status
    • Description: A request has been received for the update or modification of the object instance but this action is not yet complete.
    • Registrant Name: IESG
    • Registrant Contact Information: iesg@ietf.org

18. • Value: pending delete
    • Type: status
    • Description: A request has been received for the deletion or removal of the object instance but this action is not yet complete. For domains, this might mean that the name is no longer published in DNS but has not yet been purged from the registry database.
    • Registrant Name: IESG
    • Registrant Contact Information: iesg@ietf.org

10.2.3. Event Actions

This section registers the following values into the RDAP JSON Values Registry:

1. • Value: registration
   • Type: event action
   • Description: The object instance was initially registered.
   • Registrant Name: IESG
   • Registrant Contact Information: iesg@ietf.org

2. • Value: reregistration
   • Type: event action
   • Description: The object instance was registered subsequently to initial registration.
   • Registrant Name: IESG
   • Registrant Contact Information: iesg@ietf.org

3. • Value: last changed
   • Type: event action
   • Description: An action noting when the information in the object instance was last changed.
   • Registrant Name: IESG
   • Registrant Contact Information: iesg@ietf.org

4. • Value: expiration
   • Type: event action
   • Description: The object instance has been removed or will be removed at a pre-determined date and time from the registry.
   • Registrant Name: IESG
   • Registrant Contact Information: iesg@ietf.org

5. • Value: deletion
   • Type: event action
   • Description: The object instance was removed from the registry at a point in time that was not pre-determined.
   • Registrant Name: IESG
   • Registrant Contact Information: iesg@ietf.org

6. • Value: reinstantiation
   • Type: event action
   • Description: The object instance was reregistered after having been removed from the registry.
   • Registrant Name: IESG
   • Registrant Contact Information: iesg@ietf.org

7. • Value: transfer
   • Type: event action
   • Description: The object instance was transferred from one registrant to another.
   • Registrant Name: IESG
   • Registrant Contact Information: iesg@ietf.org

8. • Value: locked
   • Type: event action
   • Description: The object instance was locked (see the 'locked' status).
   • Registrant Name: IESG
   • Registrant Contact Information: iesg@ietf.org

9. • Value: unlocked
   • Type: event action
   • Description: The object instance was unlocked (see the 'locked' status).
   • Registrant Name: IESG
   • Registrant Contact Information: iesg@ietf.org

10.2.4. Roles

This section registers the following values into the RDAP JSON Values Registry:

1. • Value: registrant
   • Type: role
   • Description: The entity object instance is the registrant of the registration. In some registries, this is known as a maintainer.
   • Registrant Name: IESG
   • Registrant Contact Information: iesg@ietf.org

2. • Value: technical
   • Type: role
   • Description: The entity object instance is a technical contact for the registration.
   • Registrant Name: IESG
   • Registrant Contact Information: iesg@ietf.org

3. • Value: administrative
   • Type: role
   • Description: The entity object instance is an administrative contact for the registration.
   • Registrant Name: IESG
   • Registrant Contact Information: iesg@ietf.org

4. • Value: abuse
   • Type: role
   • Description: The entity object instance handles network abuse issues on behalf of the registrant of the registration.
   • Registrant Name: IESG
   • Registrant Contact Information: iesg@ietf.org

5. • Value: billing
   • Type: role
   • Description: The entity object instance handles payment and billing issues on behalf of the registrant of the registration.
   • Registrant Name: IESG
   • Registrant Contact Information: iesg@ietf.org

6. • Value: registrar
   • Type: role
   • Description: The entity object instance represents the authority responsible for the registration in the registry.
   • Registrant Name: IESG
   • Registrant Contact Information: iesg@ietf.org

7. • Value: reseller
   • Type: role
   • Description: The entity object instance represents a third party through which the registration was conducted (i.e. not the registry or registrar).
   • Registrant Name: IESG
   • Registrant Contact Information: iesg@ietf.org

8. • Value: sponsor
   • Type: role
   • Description: The entity object instance represents a domain policy sponsor, such as an ICANN approved sponsor.
   • Registrant Name: IESG
   • Registrant Contact Information: iesg@ietf.org

9. • Value: proxy
   • Type: role
   • Description: The entity object instance represents a proxy for another entity object, such as a registrant.
   • Registrant Name: IESG
   • Registrant Contact Information: iesg@ietf.org

10. • Value: notifications
    • Type: role
    • Description: An entity object instance designated to receive notifications about association object instances.
    • Registrant Name: IESG
    • Registrant Contact Information: iesg@ietf.org

11. • Value: noc
    • Type: role
    • Description: The entity object instance handles communications related to a network operations center (NOC).
    • Registrant Name: IESG
    • Registrant Contact Information: iesg@ietf.org

10.2.5. Variant Relations

This section registers the following values into the RDAP JSON Values Registry:

1. • Value: registered
   • Type: domain variant relation
   • Description: The variant names are registered in the registry.
   • Registrant Name: IESG
   • Registrant Contact Information: iesg@ietf.org

2. • Value: unregistered
   • Type: domain variant relation
   • Description: The variant names are not found in the registry.
   • Registrant Name: IESG
   • Registrant Contact Information: iesg@ietf.org

3. • Value: registration restricted
   • Type: domain variant relation
   • Description: Registration of the variant names is restricted to certain parties or within certain rules.
   • Registrant Name: IESG
   • Registrant Contact Information: iesg@ietf.org

4. • Value: open registration
   • Type: domain variant relation
   • Description: Registration of the variant names is available to generally qualified registrants.
   • Registrant Name: IESG
   • Registrant Contact Information: iesg@ietf.org

5. • Value: conjoined
   • Type: domain variant relation
   • Description: Registration of the variant names occurs automatically with the registration of the containing domain registration.
   • Registrant Name: IESG
   • Registrant Contact Information: iesg@ietf.org

11. Security Considerations

This specification models information serialized in JSON format. As JSON is a subset of Javascript, implementations are advised to follow the security considerations outlined in Section 6 of [RFC7159] to prevent code injection.

Though not specific to JSON, RDAP implementers should be aware of the security considerations specified in [I-D.ietf-weirds-using-http] and the security requirements and considerations in [I-D.ietf-weirds-rdap-sec].

Clients caching data, especially clients using RDAP specific caches (instead of HTTP layer caches), should have safeguards to prevent cache poisoning. See Section 5 for advice on using the "self" links for caching.

Finally, service operators should be aware of the privacy mechanisms noted in Section 13.

12. Internationalization Considerations

12.1. Character Encoding

The default text encoding for JSON responses in RDAP is UTF-8 [RFC3629], and all servers and clients MUST support UTF-8.

12.2. URIs and IRIs

[I-D.ietf-weirds-using-http] defines the use of URIs and IRIs in RDAP.

12.3. Language Tags

Section 4.4 defines the use of language tags in the JSON responses defined in this document.

12.4. Internationalized Domain Names

Internationalized Domain Names (IDNs) are denoted in this specification by the separation of DNS names in LDH form and Unicode form (see Section 3). Representation of IDNs in registries is described by the "variants" object in Section 5.3 and the suggested values listed in Section 10.2.5.

13. Privacy Considerations

This specification suggests status values to denote contact and registrant information that has been marked as private and/or has been removed or obscured. See Section 10.2.2 for the complete list of status values. A few of the status values indicate that there are privacy concerns associated with the object instance. The following status codes SHOULD be used to describe data elements of a response when appropriate:

• private - The object is not be shared in query responses, unless the user is authorized to view this information.
• removed - Data elements within the object have been collected, but have been omitted from the response. This option can be used to prevent unauthorized access to associated object instances without the need to mark them as private.
• obscured - Data elements within the object have been collected, but the response value has been altered so that values are not easily discernible. A value changed from "1212" to "XXXX" is an example of obscured data. This option may reveal privacy sensitive information and should only be used when data sensitivity does not require a more protective option like "private" or "removed".

See Appendix A.1 for an example applying those values to contacts and registrants.

14. Contributing Authors and Acknowledgements

This document is derived from original work on RIR responses in JSON by Byron J. Ellacott, Arturo L. Servin, Kaveh Ranjbar, and Andrew L. Newton. Additionally, this document incorporates work on DNR responses in JSON by Ning Kong, Linlin Zhou, Jiagui Xie, and Sean Shen.

The components of the DNR object classes are derived from a categorization of WHOIS response formats created by Ning Kong, Linlin Zhou, and Guangqing Deng, Steve Sheng and Francisco Arias, Ray Bellis, and Frederico Neves.

Tom Harrison, Murray Kucherawy, Ed Lewis, Audric Schiltknecht, Naoki Kambe, and Maarten Bosteels contributed significant review comments and provided clarifying text. James Mitchell provided text regarding the processing of unknown JSON attributes and identified issues leading to the remodeling of events. Ernie Dainow and Francisco Obispo provided concrete suggestions that led to a better variant model for domain names.

Ernie Dainow provided the background information on the secure DNS attributes and objects for domains, informative text on DNSSEC, and many other attributes that appear throughout the object classes of this draft.

The switch to and incorporation of jCard (JSON vCard) was performed by Simon Perreault.

Olaf Kolkman and Murray Kucherawy chaired the IETF's WEIRDS working group from which this document as been created.

15. References

15.1. Normative References

15.2. Informative References

Appendix A. Suggested Data Modeling with the Entity Object Class

A.1. Registrants and Contacts

This document does not provide specific object classes for registrants and contacts. Instead the entity object class may be used to represent a registrant or contact. When the entity object is embedded inside a containing object such as a domain name or IP network, the 'roles' string array can be used to signify the relationship. It is recommended that the values from Section 10.2.4 be used.

                        
{
  ...
  "entities" : 
  [
    {
      "objectClassName" : "entity",
      "handle" : "XXXX",
      "vcardArray":[
        "vcard",
        [
          ["version", {}, "text", "4.0"],
          ["fn", {}, "text", "Joe User"],
          ["kind", {}, "text", "individual"],
          ["lang", {
            "pref":"1"
          }, "language-tag", "fr"],
          ["lang", {
            "pref":"2"
          }, "language-tag", "en"],
          ["org", {
            "type":"work"
          }, "text", "Example"],
          ["title", {}, "text", "Research Scientist"],
          ["role", {}, "text", "Project Lead"],
          ["adr",
            { "type":"work" },
            "text",
            [
              "",
              "Suite 1234",
              "4321 Rue Somewhere",
              "Quebec",
              "QC",
              "G1V 2M2",
              "Canada"
            ]
          ],
          ["tel",
            { "type":["work", "voice"], "pref":"1" },
            "uri", "tel:+1-555-555-1234;ext=102"
          ],
          ["email",
            { "type":"work" },
            "text", "joe.user@example.com"
          ]
        ]
      ],
      "roles" : [ "registrant", "administrative" ],
      "remarks" : 
      [
        {
          "description" : 
          [
            "She sells sea shells down by the sea shore.",
            "Originally written by Terry Sullivan."
          ]  
        }
      ],
      "events" : 
      [
        {
          "eventAction" : "registration",
          "eventDate" : "1990-12-31T23:59:59Z"
        },
        {
          "eventAction" : "last changed",
          "eventDate" : "1991-12-31T23:59:59Z"
        }
      ]
    }        
  ]
}
                    
                

                        
{
  ...
  "entities" : 
  [
    {
      "objectClassName" : "entity",
      "handle" : "XXXX",
      ...
      "roles" : [ "registrant", "administrative" ],
      "status" : [ "proxy", "private", "obscured" ]
    }        
  ]
}
                    
                

        
{
  ...
  "entities":[
    {
      "objectClassName" : "entity",
      "handle":"XXXX",
      "vcardArray":[
        "vcard",
        [
          ["version", {}, "text", "4.0"],
          ["fn", {}, "text", "Joe's Fish, Chips and Domains"],
          ["kind", {}, "text", "org"],
          ["lang", {
            "pref":"1"
          }, "language-tag", "fr"],
          ["lang", {
            "pref":"2"
          }, "language-tag", "en"],
          ["org", {
            "type":"work"
          }, "text", "Example"],
          ["adr",
            { "type":"work" },
            "text",
            [
              "",
              "Suite 1234",
              "4321 Rue Somewhere",
              "Quebec",
              "QC",
              "G1V 2M2",
              "Canada"
            ]
          ],
          ["tel",
            {
              "type":["work", "voice"],
              "pref":"1"
            },
            "uri", "tel:+1-555-555-1234;ext=102"
          ],
          ["email",
            { "type":"work" },
            "text", "joes_fish_chips_and_domains@example.com"
          ]
        ]
      ],
      "roles":[ "registrar" ],
      "publicIds":[
        {
          "type":"IANA Registrar ID",
          "identifier":"1"
        }
      ],
      "remarks":[
        {
          "description":[
            "She sells sea shells down by the sea shore.",
            "Originally written by Terry Sullivan."
          ]
        }
      ],
      "links":[
        {
          "value":"http://example.net/entity/XXXX",
          "rel":"alternate",
          "type":"text/html",
          "href":"http://www.example.com"
        }
      ]
    }
  ]
}
                    
                

"events" :
[
  {
    "eventAction" : "registration",
    "eventDate" : "1990-12-31T23:59:59Z"
  }
]
                

"events" :
[
  {
    "eventAction" : "registration",
    "eventActor" : "XYZ-NIC",
    "eventDate" : "1990-12-31T23:59:59Z"
  }
]
                

                    
{
  "objectClassName" : "domain",
  "handle" : "XXXX",
  "ldhName" : "foo.example",
  "status" : [ "locked", "transfer Prohibited" ],
  ...
  "entities" : 
  [
    {
      "handle" : "XXXX",
      ...
      "asEventActor" :
      [
        {
          "eventAction" : "last changed",
          "eventDate" : "1990-12-31T23:59:59Z"
        }
      ]
    }        
  ]
} 
                    
                

{
  "vcardArray":[
    "vcard",
    [
      ["version", {}, "text", "4.0"],
      ["fn", {}, "text", "Joe User"],
      ["n", {}, "text",
        ["User", "Joe", "", "", ["ing. jr", "M.Sc."]]
      ],
      ["kind", {}, "text", "individual"],
      ["lang", {
        "pref":"1"
      }, "language-tag", "fr"],
      ["lang", {
        "pref":"2"
      }, "language-tag", "en"],
      ["org", {
        "type":"work"
      }, "text", "Example"],
      ["title", {}, "text", "Research Scientist"],
      ["role", {}, "text", "Project Lead"],
      ["adr",
        { "type":"work" },
        "text",
        [
          "",
          "Suite 1234",
          "4321 Rue Somewhere",
          "Quebec",
          "QC",
          "G1V 2M2",
          "Canada"
        ]
      ],
      ["adr",
        {
          "type":"home",
          "label":"123 Maple Ave\nSuite 90001\nVancouver\nBC\n1239\n"
        },
        "text",
        [
          "", "", "", "", "", "", ""
        ]
      ],
      ["tel",
        { "type":["work", "voice"], "pref":"1" },
        "uri", "tel:+1-555-555-1234;ext=102"
      ],
      ["tel",
        {
          "type":["work", "cell", "voice", "video", "text"]
        },
        "uri",
        "tel:+1-555-555-1234"
      ],
      ["email",
        { "type":"work" },
        "text", "joe.user@example.com"
      ],
      ["geo", {
        "type":"work"
      }, "uri", "geo:46.772673,-71.282945"],
      ["key",
        { "type":"work" },
        "uri", "http://www.example.com/joe.user/joe.asc"
      ],
      ["tz", {},
        "utc-offset", "-05:00"],
      ["url", { "type":"home" },
        "uri", "http://example.org"]
    ]
  ]
}