JSON for RESTful Provisioning Protocol (RPP)

Introduction The RESTful Provisioning Protocol (RPP) defines a set of data objects for managing foundational registry resources including domain names, contacts, and hosts. The data model is defined in independently of any particular representation format. This document defines the JSON representation of those data objects. JSON has emerged as the de facto standard data format for modern RESTful APIs. Its widespread adoption across tools, libraries, and developer communities makes it well suited as the primary representation format for RPP. This document provides the normative rules and JSON Schema definitions required for implementations to produce and consume RPP messages in JSON. The separation between the abstract data model and its concrete JSON representation ensures that the protocol's semantic foundation remains stable while enabling the adoption of JSON across diverse deployment environments.

Motivation The RESTful Provisioning Protocol (RPP) introduces a new provisioning mechanism that aligns more closely with modern cloud infrastructure, enhancing the scalability of server deployments. While RESTful protocols do not mandate a specific media type for resource description, the widespread adoption of JSON in web services has established it as the de facto standard for modern APIs. The increasing availability of tools, software libraries, and a skilled workforce has led several registries to adopt JSON for data exchange within their API ecosystems. Registries supporting JSON can offer a unified API ecosystem that extends beyond domain name and IP address provisioning, maintaining a consistent technology stack, data formats, and developer experience. JSON's syntax, known for its straightforwardness and minimal verbosity, significantly eases the tasks of writing, reading, and maintaining code. This simplicity is especially advantageous for the rapid comprehension and integration of provisioning APIs. The lightweight nature of JSON can result in faster processing and data transfers, a critical aspect in high-volume transaction environments such as domain registration. Enhanced API response times can lead to more efficient domain lookups, registrations, and updates. JSON parsing is typically fast and well-supported by standard libraries, contributing to improved system performance amid frequent interactions between RPP clients and servers. However, the absence of a standardized JSON format for domain provisioning has led to the emergence of TLD-specific implementations that lack interoperability, increasing the development effort required for integration. Similarly, at the registrar level, the absence of standards has resulted in numerous incompatible API implementations provided to clients and resellers. Standardizing a JSON format for domain provisioning within the RPP framework could mitigate these challenges, reducing fragmentation and simplifying integration efforts across the domain registration industry.

Terminology In this document, the following terminology is used. RPP Data Objects - The abstract data model definitions for domain name, contact, and host resources, as specified in . RESTful Provisioning Protocol - A RESTful protocol for provisioning heterogeneous database objects. JSON Schema - A vocabulary that allows annotation and validation of JSON documents, as described in . EPP Compatibility Profile - A set of additional constraints defined in that a server MUST adhere to when supporting both RPP and EPP concurrently.

Conventions Used in This Document The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in . JSON is case sensitive. Unless stated otherwise, JSON specifications and examples provided in this document MUST be interpreted in the character case presented. The examples in this document assume that request and response messages are properly formatted JSON documents. Indentation and white space in examples are provided only to illustrate element relationships and for improving readability, and are not REQUIRED features of the protocol. All JSON Schema definitions in this document use JSON Schema draft 2020-12 , and where not provided with a $schema keyword, the following default applies:

JSON Representation Rules This section defines the normative rules for representing the RPP data model in JSON. The data model is specified in , which defines all primitive types, common data types, component objects, resource objects, and associations independently of any concrete representation format. The rules in this section specify how those abstract definitions map to JSON and JSON Schema version 2020-12.

Primitive Type Mappings RPP primitive types MUST be represented in JSON as follows:

RPP Primitive Type	JSON Type	Notes
String	`string`	Unicode character sequence
Integer	`number`	Whole number, positive or negative
Boolean	`boolean`	`true` or `false`
Decimal	`string`	Base-10 fractional value with exact representation within a defined precision. Number is encoded into string same as `"number"` in without exponent part `"ext"`.
Date	`string`	Full-date as per , e.g. `"2025-10-27"`
Timestamp	`string`	Date-time in UTC as per , e.g. `"2025-10-27T09:42:51Z"`
URL	`string`	Uniform Resource Locator as per
Binary	`string`	Base64-encoded binary data

Cardinality Rules The cardinality of each data element in the RPP data model MUST be represented as follows in JSON: Rule 1: A data element with cardinality 1 (exactly one) MUST be represented as a JSON property and MUST be present in the containing JSON object. The element MUST be listed under required in the corresponding JSON Schema. Rule 2: A data element with cardinality 0-1 (zero or one) MUST be represented as an optional JSON property. The element MUST NOT be listed under required in the corresponding JSON Schema. When absent, the element MUST be omitted from the JSON object (not represented as null). Rule 3: A data element with cardinality 0+ (zero or more) MUST be represented as an optional JSON array. When no values are present, the property MUST be omitted or represented as an empty array. Rule 4: A data element with cardinality 1+ (one or more) MUST be represented as a required JSON array with "minItems": 1 and the element MUST be listed under required in the corresponding JSON Schema.

Mutability Rules Data elements in the RPP data model carry a mutability attribute: create-only, read-only, or read-write. These MUST be represented in JSON Schema as follows: Rule 5: Data elements with mutability read-only MUST be annotated with "readOnly": true in the JSON Schema. Clients MUST NOT include read-only properties in create or update request bodies. Servers MUST ignore any read-only properties provided by a client in a request. Rule 6: Data elements with mutability create-only MUST be annotated with "writeOnly": true in the JSON Schema for request schemas, and excluded from update request schemas. Servers MUST reject requests that attempt to modify a create-only element after object creation. Rule 7: Data elements with mutability read-write have no additional annotation. They MAY appear in both request and response bodies.

Association Rules The RPP data model defines several association types between objects, the following rules specify their JSON representations. A Aggregation represents a relationship between two independent objects, where one object references another. A Composition represents a parent-child relationship where the child object is embedded within the parent object and cannot exist independently.

Labelled associations Some associations between objects carry a string label that provides additional context for the relationship. The label is not an identifier of the target object, but rather a descriptor of the association itself. Labelled associations can occur in both aggregations and compositions. When representing labelled associations in JSON, the property label MUST be included alongside the reference to the target object. A property with the name object MUST be used to contain the reference to the target object, which can be either limited representation containing at minimum the primary object identifier for aggregations or an embedded object for compositions.

Aggregation An Aggregation[Type] represents a relationship between two independent objects. When the cardinality allows more than one target, it MUST be represented as a JSON array. Each element of the array MUST be the identifier of the referenced object. Rule 8: Aggregation[Type] with cardinality 0+ or 1+ MUST be represented as a JSON array of embedded objects. Each object in the array MUST include the data elements of the referenced object type that are relevant to the context (at minimum the primary identifier field). Other data elements of the referenced object type MAY be included as needed to provide additional context for the client, but are not required. The JSON Schema MUST allow for the presence of these additional fields. Example: domain nameservers (Aggregation[Host Data Object]) in a read response, returning a limited object representation containing only the primary identifier field hostName:

Composition A Composition[Type] represents a parent-child relationship where the child's lifecycle is bound to the parent and the child cannot exist independently of the parent. In JSON, the child object MUST be fully embedded within the parent object. The JSON representation of a composition is the same as that of an aggregation. The distinction between the two is semantic and does not affect the JSON structure.

Labelled Aggregation A LabelledAggregation[Type] is a relationship between two independent objects where each association carries a string label. Multiple associations with the same label are allowed. Rule 9: LabelledAggregation[Type] with cardinality 0+ MUST be represented as a JSON array of objects. Each object in the array MUST contain a label property (string) alongside the identifier of the referenced object. The object MUST include at least the primary identifier field of the referenced object type. Other data elements of the referenced object type MAY be included as needed to provide additional context for the client, but are not required. The JSON Schema MUST allow for the presence of these additional fields. Example: domain contacts (LabelledAggregation[Contact Object]):

Dictionary Aggregation A DictionaryAggregation[Type] is a relationship between two independent objects where each association carries a unique string label that serves as a dictionary key. Rule 10: DictionaryAggregation[Type] MUST be represented as a JSON object where each key is the unique label and the corresponding value is the referenced object, the object MUST include at least the primary identifier field of the referenced object type. Other data elements of the referenced object type MAY be included as needed to provide additional context for the client, but are not required. The JSON Schema MUST allow for the presence of these additional fields. Example: domain contacts keyed by unique role (DictionaryAggregation[Contact Object]):

Labelled Composition A LabelledComposition[Type] is a parent-child relationship where each embedded child carries a string label. Multiple instances with the same label are allowed. Rule 11: LabelledComposition[Type] with cardinality 0+ MUST be represented as a JSON array of embedded objects. Each object in the array MUST contain a label property alongside the data elements of the composed type. Example: remarks (LabelledComposition[Remark Object]):

Dictionary Composition A DictionaryComposition[Type] is a parent-child relationship where each embedded child carries a unique string label used as a dictionary key. Rule 12: DictionaryComposition[Type] MUST be represented as a JSON object where each key is the unique label and the corresponding value is the fully embedded child object. Example: remarks keyed by scope (DictionaryComposition[Remark Object]):

Object Identifier Rules Rule 13: When a resource or component object is referenced by identifier (for example in an aggregation), the identifier MUST be represented as a JSON string using the value of the object's primary identifier data element. Rule 14: When a resource or component object is embedded (as in a composition), all data elements of the object MUST be represented as properties of a JSON object according to the rules of this section.

External Type Embedding Rules RPP data objects may include data elements whose types are defined by external specifications (e.g., JSContact in ). When embedding a value of an externally defined type into a JSON representation, the following rules apply, in order of preference: Rule 15: If the external type has a native JSON representation (i.e., the external specification defines how the type is represented using the JSON format), the value MUST be embedded as a valid JSON element using the native JSON representation defined by that specification. Rule 16: If the external type does not have a native JSON representation but has a native UTF-8 encoded text representation, the value MUST be embedded as a JSON string using the UTF-8 encoding. Rule 17: If the external type has neither a native JSON nor a native UTF-8 text representation, the binary representation of the value MUST be Base64-encoded (, Section 4) and embedded as a JSON string.

Process Data Embedding Rules As defined in , a uniform interface operation MAY require process data in addition to the object representation data. This section defines how such process data MUST be represented in JSON when transmitted together with the object representation in a single request body. Rule 18: Process data accompanying a uniform interface operation MUST be represented using the processes data element of the owning resource object (see Processes Object), following the Aggregation rules for the corresponding process type (for example createProcess for creation-specific inputs). Each embedded process object MUST be a valid JSON representation of the process object. This applies uniformly regardless of whether the resource object already exists. Example: a domain create request body carrying a two-year registration period as process data embedded in a createProcess process object under processes:

JSON Schema Definition Rules Rule 20: Each RPP component object and resource object MUST have a corresponding JSON Schema definition. Object definitions MUST be placed in the $defs keyword of the JSON Schema document. Rule 21: Identifier fields MUST use "type": "string" in JSON Schema. Rule 22: Enumeration constraints on string fields MUST be expressed using the "enum" keyword in JSON Schema. Example (Transfer Status enum): Rule 23: Each JSON Schema definition for an RPP object MUST include a "required" array listing all data elements with cardinality 1 or 1+. Rule 24: JSON Schema definitions for extendible RPP objects MUST NOT use "additionalProperties": false or "unevaluatedProperties": false. However, before validation, schemas on every property level MUST be enriched with "unevaluatedProperties": false property to prevent the presence of undeclared properties in JSON instances. JSON Schemas for Object type MAY use "additionalProperties": true to allow for free key definition. Rule 25: Every RPP object representation MUST include a "@type" property whose value is the object's identifier as registered in the IANA RPP Data Object Registry. This property enables identification and allows clients and servers to unambiguously determine the type of an object. The "@type" property MUST be included in the JSON Schema "properties" object for each RPP object definition with a "const" constraint fixing the value to the object's registered identifier. The "@type" property MUST be listed in the "required" array of the corresponding JSON Schema definition. Example (Domain Name Data Object): Rule 26: When a transfer request or other operation requires authorization information (e.g., EPP-style authinfo), the client MUST NOT include the authInfo object in the JSON request body. Instead, the client MUST convey the authorization information using the RPP-Authorization HTTP request header as defined in . Servers MUST reject any request that includes an authInfo object in the JSON body with an appropriate error response.

RPP Profiles and Validation RPP profiles, such as the EPP Compatibility Profile defined in , may impose additional constraints on top of the base RPP data model. These additional constraints MUST be enforced by implementations through validation rules that go beyond what can be expressed in JSON Schema. Such validation rules MUST be clearly documented in the profile specification and implemented by both clients and servers when operating under that profile. For example, the EPP Compatibility Profile requires that certain fields be present in specific object types, and that certain identifier fields conform to EPP syntax rules. These constraints cannot be fully captured in JSON Schema and therefore require additional validation logic in implementations.

Update Rules NOTE: The update rules in this section are still under discussion and may be subject to change. Feedback from the community is welcome.

Full A full update operation replaces the entire state of a resource object with the new representation provided in the request, all required properties MUST be included in the new representation.

Partial A partial update operation allows clients to update specific properties of a resource object, while leaving other properties unchanged. A partial update MUST use JSON Patch and an RPP extension to support the match property for matching of array elements. The match property is used to identify a specific element in an array, it is a JSON object that contains key-value pairs corresponding to the properties of the array elements. The server uses the match property to locate the specific element in the array that should be updated, removed, or replaced. The server MUST compare every key and corresponding value in the match object against the properties of each element in the array. If an element matches all key-value pairs in the match object, it is considered a match. If the righthand side of the match property contains a complex datatype (object or array), the match property MUST contain a key named object, the value of which is a JSON object that contains the properties to be matched against. The server MUST compare the properties of the nested object against the corresponding properties of the array element. If all properties match, the element is considered a match. The server MUST NOT allow recursive matching of nested data structures. The match property is only used for matching elements in the immediate array specified by the path property of the JSON Patch operation. If the array elements contain nested objects or arrays, the server MUST NOT attempt to match against those nested structures. Example domain object for matching an array element with a specific key-value pair: Example match object for matching the array element with the "tech" label and the contact ID "REG-200" in the contacts array of the domain object above: For the remove operation, if multiple matched elements are found, then the sever MUST remove all matched elements. For the replace operation, if multiple matched elements are found, then the server MUST return an error response indicating that the operation is ambiguous and cannot be performed. If a match does not have any results, then the server MUST return an error response indicating that the specified element could not be found. The following rules apply for partial updates:

Rule 25: JSON Patch operations other than "add", "remove" and "replace" MUST NOT be used.
Rule 26: If a JSONPointer path points to field using a JSON simple data type (e.g. string or number) then the "value" property MUST be provided and its type MUST match the type of the target field.
Rule 27: If a JSONPointer path points to an object, then the "value" property MUST be provided and contain a valid object, the new object's "@type" property MUST match the "@type" of the target object.
Rule 28: If a JSONPointer path points to an array, then:
- The "match" property MUST be provided to identify the specific element to be updated.
- The "match" property MUST only be used for matching array elements of the same type, and the rules 26 and 27 apply.
- The value of the "op" property determines the action to be taken on the matched element:
  - The "add" operation, appends the new value to the array.
  - The "remove" operation, removes the specified value from the array.
  - The "replace" operation, replaces the existing value at the matching array element with the specified value.
- If the value of the "op" property is "replace", and there is a matching element, then the element MUST be fully replaced with the new value provided in the "value" property. The new value MUST include all required fields for the object type.
Rule 29: If any of the JSONPointer paths in the request fail to match an existing field or element in the target resource object, the server MUST reject the complete request with an appropriate error response.

Schema A partial update request body MUST be a JSON array of patch operation objects. Each operation MUST include an op and a path property. The value property MUST be present for add and replace operations. The match property MUST be present when the path points to an array property and is used to identify the specific array element to operate on.

Examples Example JSON document used by partial update examples below: Example of a partial update request to change the registrant of a domain name from "jd1234" to "jd1234-new": Example of a partial update request to change the status of a domain name from "ok" to "clientProhibited": Example of a partial update request for adding a additional tech contact to a domain name:

JSON Schema Definitions This section provides normative JSON Schema definitions for RPP component objects and resource objects. All schemas use JSON Schema draft 2020-12 .

Common Data Types Schemas This section defines shared data types that are based on the primitive data types above and are re-used across multiple data object definitions.

Identifier Identifiers are character strings with a specified minimum length, a specified maximum length, and a specified format outlined in . Identifiers for certain object types MAY have additional constraints imposed either by server policy, object-specific specifications, or both. In JSON, an Identifier MUST be represented as a string value conforming to the roidType syntax defined in : one to eight word characters optionally preceded by an underscore, followed by a hyphen and one or more word characters, with a maximum total length of 89 characters.

Client Identifier Client identifiers are character strings with a specified minimum length, a specified maximum length, and a specified format. Client identifiers use the clIDType syntax described in . In JSON, a Client Identifier MUST be represented as a string value.

Phone Number Telephone number syntax is derived from structures defined in . Telephone numbers described in this specification are character strings that MUST begin with a plus sign ("+", ASCII value 0x002B), followed by a country code defined in , followed by a dot (".", ASCII value 0x002E), followed by a sequence of digits representing the telephone number. An optional "x" (ASCII value 0x0078) separator with additional digits representing extension information can be appended to the end of the value. In JSON, a Phone Number MUST be represented as a string value conforming to the pattern described above.

Component Objects Schemas

Period Object

Provisioning Metadata Object The following constraints cannot be expressed in JSON Schema and MUST be enforced by implementations:

upClientId and upDate MUST NOT be present if the object has never been modified.
trDate MUST NOT be present if the object has never been transferred.
In EPP Compatibility Profile, repositoryId MUST be provided.

Status Object The following constraints cannot be expressed in JSON Schema and MUST be enforced by implementations:

label MUST use camelCase notation using only ASCII alphabetic characters. Labels set explicitly by the server MUST use the prefix "server"; labels set explicitly by a client MUST use the prefix "client"; all other labels MUST NOT use either prefix. The allowed set of label values depends on the provisioning object type and MAY be extended by extensions.
due: Servers MAY restrict the ability of clients to set or update this value.
When the RGP feature is supported, the following additional status labels MAY appear on objects that support RGP: addPeriod, autoRenewPeriod, renewPeriod, transferPeriod, redemptionPeriod, pendingRestore, rgpPendingDelete. The labels redemptionPeriod, pendingRestore, and rgpPendingDelete MUST only appear alongside the standard pendingDelete status.

DNS Resource Record Object The following constraints cannot be expressed in JSON Schema and MUST be enforced by implementations:

name MUST be a syntactically valid DNS host name in zone file string representation. Both absolute FQDNs (with trailing dot) and relative host names are allowed, as well as the @ symbol representing the domain name itself.
type MUST be a valid string representation of a DNS resource record type as defined in . Values MUST be converted to lower case. Allowed values MAY be further constrained by server policy.
In EPP Compatibility Profile (), the following record types MUST be supported: ns, a, and aaaa. With DNSSEC Extension , ds and dnskey MUST additionally be supported.
class, if present, MUST be chosen from Section 3.2.4 (CLASS values) of . A client SHOULD omit this element; the server MUST assume IN as the default.
The fields within rdata MUST match the expected structure for the given record type (see RDATA structures below).

RDATA structures required in EPP Compatibility Profile:

NS records (, Section 3.3.11): nsdname
A records (, Section 3.4.1): address
AAAA records (, Section 2.2): address
DS records (, Section 5, with DNSSEC Extension): keyTag, algorithm, digestType, digest
DNSKEY records (, Section 2, with DNSSEC Extension): flags, protocol, algorithm, publicKey

All rdata property names MUST be written in camelCase and all values MUST use the string data type.

DNS Operational Controls Object The DNS Operational Controls Object contains operational control parameters that a client MAY use to influence server-side DNS behaviour for a set of DNS records. A server MAY ignore these values, e.g. for policy reasons. This structure is aligned with .

DNS Data Object The DNS Data Object is a container for DNS resource records and associated operational controls for a provisioned object. This structure groups DNS records together with control parameters that influence server-side DNS behaviour. It is aligned with . The following constraints cannot be expressed in JSON Schema and MUST be enforced by implementations:

In EPP Compatibility Profile with DNSSEC Extension , records of type ds and dnskey MUST be supported in addition to ns, a, and aaaa. A server MUST support either ds or dnskey or both. If provided with only dnskey, a server MUST calculate the DS record.

Authorization Information Object The following constraints cannot be expressed in JSON Schema and MUST be enforced by implementations:

method MUST be one of the values registered in the IANA RPP Authorization Method Registry as defined in . In EPP Compatibility Profile, this value MUST be "authinfo" for standard password-based authorization.
The Authorization Information Object is immutable. When authorization information changes, a new instance MUST be created rather than modifying the existing one. The value of authdata MAY be omitted from read responses, depending on the method and server policy.

JSContact Card Object The Contact Data Object uses version 2.0 of JSContact to represent contact information. The Contact object is defined below according to the RPP JSContact Profile [TODO Add Ref]. The following constraints cannot be expressed in JSON Schema and MUST be enforced by implementations:

addresses[*].countryCode MUST be a valid two-character ISO 3166-1 alpha-2 code when present.
localizations MUST be fully expanded; nested PatchObject-style keys (e.g., "addresses/addr/full") are NOT allowed.
When phones[*].features is absent, the number MUST be treated as a voice number.

Restore Report Object The Restore Report Object contains the redemption grace period restore report submitted by the sponsoring client as required by the RGP process (). The following constraints cannot be expressed in JSON Schema and MUST be enforced by implementations:

At least one and at most two statements MUST be provided.
restoreTime MAY be omitted when the restore report is submitted inline within the restore request in a single-step process.
In EPP Compatibility Profile, restoreTime MUST be present as defined in .
In EPP Compatibility Profile, exactly two statements MUST be present as defined in .

Organisation Role Object The following constraints cannot be expressed in JSON Schema and MUST be enforced by implementations:

type MUST only use values registered in the IANA "EPP Organization Role Values" registry ().

Processes Object The Processes Object is a read-only container grouping the currently active Process Objects on the owning resource object, keyed by process type. Each key holds an array of the corresponding Process Object's read representation, per the Aggregation rules.

Process Object Schemas

Create Process Object The Create Process Object carries the process-specific inputs for a resource creation operation, such as the requested registration period. It is submitted as an element of the createProcess array under the processes data element of the owning resource object (see Processes Object), following the same Aggregation representation as the other process types. Create request schema (create-only and read-write properties): Read response schema (read-only properties):

Renew Process Object Renew request schema (create-only properties): Renew response schema (read-only properties):

Transfer Process Object

Create Create request schema (create-only and read-write properties):

Read Read response schema (read-write and read-only properties):

Approve The Approve operation MUST always have a request body, which may be an empty JSON object. The server can identify the transfer process to be approved based on the request URL and the authenticated client's permissions. There is no Approve request schema defined in this specification. The Approve response schema MUST equal the read response schema.

Cancel The Cancel operation, which is similar to a delete operation, has no request body, the server can identify the transfer process to be cancelled based on the request URL and the authenticated client's permissions. Because the Cancel operation has no request body, it is not possible to extend the request schema with additional properties. The Cancel response schema MUST equal the read response schema or an empty response.

Reject Reject request schema: Reject response schema MUST equal the read response schema.

Restore Process Object The Restore Process Object represents the current state of a restore request for an object that has entered the Redemption Grace Period (RGP). It is returned as a response for all restore operations. The following constraints cannot be expressed in JSON Schema and MUST be enforced by implementations:

requestDate MUST NOT be present if no restore request has been submitted yet.
reportDate MUST NOT be present if no restore report has been accepted yet.
reportDueDate MUST NOT be present when restoreStatus is not "pendingRestore".

Create request schema (create-only and read-write properties): Read response schema (read-write and read-only properties):

Domain Name Data Object The Domain Name Data Object represents a domain name and its associated provisioning data. The following constraints cannot be expressed in JSON Schema and MUST be enforced by implementations:

name MUST be a fully qualified domain name conforming to the syntax described in . Servers MAY restrict allowable domain names to a specific namespace for which they are authoritative. The implicit trailing dot MUST NOT be included.

Create Create request schema (create-only and read-write properties):

Read Read response schema (read-write and read-only properties):

Update Update request schema (read-write properties):

Renew Renew minimal response schema (only expire date):

Transfer Create request for Domain Transfer Process Object schema (create-only and read-write properties): Read response for Domain Transfer Process Object schema (read-write and read-only properties): Both Approve and Delete (Cancel) operations have no request body, the server can identify the transfer process to be approved or cancelled based on the request URL and the authenticated client's permissions. Delete (Cancel) response Domain Transfer Process Object schema (read-write and read-only properties): Approve response Domain Transfer Process Object schema (read-write and read-only properties): Reject request Domain Object schema: Reject response schema (read-write and read-only properties):

Reference Reference schema (identifier only):

Contact Data Object This document uses version 2.0 of JSContact for the JSON representation of Contact Data Object contact information. The contact's name, postal address, phone numbers, email addresses, and other contact details are encapsulated in a JSContact Card object embedded in the contactInfo property.

JSContact Profile for RPP Since JSContact is a general-purpose representation of contact data, this document defines a restricted usage profile for use within RPP, see [TODO: ref to RPP JSContact profile here: https://github.com/SIDN/ietf-rpp-jscontact-profile]. The following constraints cannot be expressed in JSON Schema and MUST be enforced by implementations:

card.name.full MUST be provided in EPP Compatibility Profile.
card.addresses.addr MUST be provided in EPP Compatibility Profile, containing at least countryCode and a "locality" kind component.
card.emails.email.address MUST be provided in EPP Compatibility Profile.
card.addresses[*].countryCode MUST be a valid two-character ISO 3166-1 alpha-2 code when present.

Create Create request schema (create-only and read-write properties):

Read Read response schema (read-write and read-only properties):

Update Update request schema (read-write properties):

Transfer Transfer create request for Contact Object schema (create-only and read-write properties):

Reference Reference schema (identifier only):

Host Data Object The following constraints cannot be expressed in JSON Schema and MUST be enforced by implementations:

hostName MUST be a syntactically valid fully qualified host name.
If the host name is subordinate to a domain for which the server is authoritative, the superordinate domain MUST already exist in the server.

Create Create request schema (create-only and read-write properties):

Read Read response schema (read-write and read-only properties):

Update TODO

Reference Reference schema (identifier only):

Organisation Data Object The following constraints cannot be expressed in JSON Schema and MUST be enforced by implementations:

id MUST be a server-unique identifier conforming to the Identifier syntax.
status MUST always contain at least one value. pendingCreate, ok, hold, and terminated are mutually exclusive. ok MAY only be combined with linked.
parent, if present, MUST reference a known Organisation Object. Circular parent references MUST be rejected.
contacts keys MUST be contact type values registered in the IANA "EPP Organisation Contact Types" registry ().

Create Create request schema (create-only and read-write properties):

Read Read response schema (read-write and read-only properties):

Update Update request schema (read-write properties):

Reference Reference schema (identifier only):

User Data Object The User Data Object represents a user linked to an Organisation Object. The lifecycle of a User Object is bound to its owning Organisation Object. Note: User status values are plain strings, not Status Objects.

Create Create request schema (create-only and read-write properties):

Read Read response schema (read-write and read-only properties):

Update Update request schema (read-write properties):

Reference Reference schema (identifier only):

Examples This section provides examples that follow the JSON representation rules and JSON Schema definitions specified in the previous sections. The examples illustrate typical request and response messages for domain name, contact, and host resources.

Domain Name

Create Example domain create request: Example domain create response from a server with RGP support:

Create Process Data Example Create Process Object for a two-year registration period, as embedded above in processes.createProcess:

Read Example domain read response:

Update Example domain update request (read-write properties): Example domain update response:

Delete The domain delete operation takes the domain name as the resource identifier in the request. No request body is required. Example domain delete response (minimal, server may return full representation):

Renew The renew operation creates a Renew Process Object. The optional expiryDate in the request is the current expiry date, sent by the client for server-side validation to prevent duplicate renewals. The response returns a Renew Process Object containing the new expiry date. Example domain renew request: Example domain renew response:

Transfer Request Authorization information for the transfer MUST be conveyed using the RPP-Authorization HTTP header (see Rule 21), not in the JSON request body. Example domain transfer request (pull transfer) Example domain transfer response (Transfer Process Object):

Transfer Query Example domain transfer query response (Transfer Process Object):

Transfer Approve The Transfer approve operation has request body with an empty JSON object, the server can identify the transfer process to be approved based on the request URL and the authenticated client's permissions. Example domain transfer approve request with empty JSON object: The response is the Transfer Process Object, similar to the transfer create and query responses.

Transfer Cancel The Transfer cancel operation has an empty request body, the server can identify the transfer process to be cancelled based on the request URL and the authenticated client's permissions. The response is the Transfer Process Object, similar to the transfer create and query responses.

Transfer Reject Example domain transfer reject request The transfer reject response is the Transfer Process Object, similar to the transfer create and query responses.

Restore Request Example domain restore request (without inline report; object transitions to pendingRestore state): Example domain restore response (Restore Process Object, server requires a report): Example domain restore request with inline restore report (single-step; object restored immediately): Example domain restore response with inline report (Restore Process Object, immediately restored):

Restore Report Example domain restore report request: Example domain restore report response (Restore Process Object):

Restore Query The Restore Query operation takes no request body (Parameters: None). Example domain restore query response (Restore Process Object, object in pendingRestore state): Example domain restore query response (Restore Process Object, object restored):

Contact

Create Example contact create request: Example contact create response:

Read Example contact read response:

Update Example contact update request: Example contact update response:

Delete The contact delete operation takes the contact identifier as the resource identifier. No request body is required.

Transfer Request Authorization information for the transfer MUST be conveyed using the RPP-Authorization HTTP header (see Rule 21), not in the JSON request body. Example contact transfer request (pull transfer) Example contact transfer response (Transfer Process Object):

Transfer Query Example contact transfer query response (Transfer Process Object):

Transfer Cancel / Approve Transfer cancel and approve responses return the Transfer Process Object. The response structure is the same as the Transfer Query response above. The trStatus value reflects the outcome of the operation (e.g. "clientCancelled", "clientRejected", or "clientApproved").

Transfer Reject Example Contact Transfer Reject request The transfer reject response is the Transfer Process Object, similar to the transfer create and query responses.

Host

Create Example host create request: Example host create response:

Read Example host read response:

Update Example host update request:

Delete The host delete operation takes the host name as the resource identifier. No request body is required. The server SHOULD reject the request if the host object is associated with any domain name objects.

Restore Request Example host restore request (without inline report; object transitions to pendingRestore state): Example host restore request response (Restore Process Object, server requires a report): Example host restore request with inline restore report (single-step; object restored immediately): Example host restore response with inline report (Restore Process Object, immediately restored):

Restore Report Example host restore report request: Example host restore report response (Restore Process Object):

Restore Query The Restore Query operation takes no request body (Parameters: None). Example host restore query response (Restore Process Object, object in pendingRestore state): Example host restore query response (Restore Process Object, object restored):

Organisation

Create Example organisation create request: Example organisation create response:

Read Example organisation read response:

Update Example organisation update request:

Delete The organisation delete operation takes the organisation identifier as the resource identifier. No request body is required. The server MUST reject the request if the organisation object is associated with any other objects.

Reference Example organisation reference (used when referencing an organisation from another object):

User

Create Example user create request: Example user create response:

Read Example user read response:

Update Example user update request (suspend the user):

Delete The user delete operation takes the user identifier as the resource identifier in the context of the owning organisation. No request body is required.

Reference Example user reference (used when referencing a user from an organisation object):

IANA Considerations TODO

Internationalization Considerations TODO

Security Considerations TODO

Acknowledgments TODO

Change History

Version draft-wullink-rpp-json-02 to draft-ietf-rpp-json-00

Added "Update Rules" section, describing update requests (Issue #54)
Added schema and examples for Transfer approve/reject/cancel operations (Issue #28)
Added Organisation and User Object JSON schemas and examples. (Issue #57)
Added schema and examples for the Renew Process Object. (Issue #45)
Added representation for embedding of process data in uniform interface operations (especially create). (Issue #60)
Added JSContact as External Type Embedding (Issue #43).

Version 01 to 02

Adjust rule 19 and all schemas to match it.

Version 00 to 01

Updated all examples and schemas to be based on RPP Data Object and no longer on EPP XML schemas. (Issue #15)
Updated labelled and dictionary aggregation rules (Issue #17)
Added required "@type" property to all JSON Schema definitions. (Issue #20)
Updated all example domain names to use the .example TLD. (Issue #26)