RFC 8543
Extensible Provisioning Protocol (EPP) Organization Mapping
📜 RFC 8543: Extensible Provisioning Protocol (EPP) Organization Mapping 💖
okay so bestie, this is Part 1 of 7 of RFC 8543, and it's giving serious standards-track energy 💅 It's an IETF Standards Track document (so it's the real deal, not an experiment 🔥), published in March 2019 by L. Zhou (CNNIC), N. Kong (Consultant), J. Yao (CNNIC), J. Gould (VeriSign, Inc.), and G. Zhou (no affiliation listed, just vibes 🌸). It lives in ISSN 2070-1721 and is an IETF product approved by the IESG 🎀. It doesn't obsolete or update any other RFCs, so it's a fresh start, no drama 🦋.
The whole point is this: lots of entities in the domain registration business, like registrars, resellers, DNS service operators, and privacy proxies, were never formally defined as an object in EPP. This document gives them a proper home as "organization" entities 🧚
Abstract
This document describes an Extensible Provisioning Protocol (EPP) mapping for provisioning and management of organization objects stored in a shared central repository. 💜
Status of This Memo
This is an Internet Standards Track document. ⭐
This document is a product of the Internet Engineering Task Force (IETF). It represents the consensus of the IETF community. It has received public review and has been approved for publication by the Internet Engineering Steering Group (IESG). Further information on Internet Standards is available in Section 2 of RFC 7841. 🌈
Information about the current status of this document, any errata, and how to provide feedback on it may be obtained at https://www.rfc-editor.org/info/rfc8543. 🔗
Copyright Notice
Copyright (c) 2019 IETF Trust and the persons identified as the document authors. All rights reserved. 🎀
This document is subject to BCP 78 and the IETF Trust's Legal Provisions Relating to IETF Documents (https://trustee.ietf.org/license-info) in effect on the date of publication of this document. Please review these documents carefully, as they describe your rights and restrictions with respect to this document. Code Components extracted from this document must include Simplified BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Simplified BSD License. 🙈
Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 3
2. Conventions Used in This Document . . . . . . . . . . . . . . 3
3. Object Attributes . . . . . . . . . . . . . . . . . . . . . . 3
3.1. Organization Identifier . . . . . . . . . . . . . . . . . 4
3.2. Organization Roles . . . . . . . . . . . . . . . . . . . 4
3.2.1. Role Type . . . . . . . . . . . . . . . . . . . . . . 4
3.2.2. Role Status . . . . . . . . . . . . . . . . . . . . . 4
3.2.3. Role Identifier . . . . . . . . . . . . . . . . . . . 4
3.3. Contact and Client Identifiers . . . . . . . . . . . . . 5
3.4. Organization Status Values . . . . . . . . . . . . . . . 5
3.5. Role Status Values . . . . . . . . . . . . . . . . . . . 7
3.6. Parent Identifier . . . . . . . . . . . . . . . . . . . . 7
3.7. URL . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
3.8. Dates and Times . . . . . . . . . . . . . . . . . . . . . 8
4. EPP Command Mapping . . . . . . . . . . . . . . . . . . . . . 8
4.1. EPP Query Commands . . . . . . . . . . . . . . . . . . . 8
4.1.1. EPP <check> Command . . . . . . . . . . . . . . . . . 8
4.1.2. EPP <info> Command . . . . . . . . . . . . . . . . . 10
4.1.3. EPP <transfer> Query Command . . . . . . . . . . . . 15
4.2. EPP Transform Commands . . . . . . . . . . . . . . . . . 16
4.2.1. EPP <create> Command . . . . . . . . . . . . . . . . 16
4.2.2. EPP <delete> Command . . . . . . . . . . . . . . . . 20
4.2.3. EPP <renew> Command . . . . . . . . . . . . . . . . . 21
4.2.4. EPP <transfer> Command . . . . . . . . . . . . . . . 21
4.2.5. EPP <update> Command . . . . . . . . . . . . . . . . 21
4.3. Offline Review of Requested Actions . . . . . . . . . . . 25
5. Formal Syntax . . . . . . . . . . . . . . . . . . . . . . . . 27
6. Internationalization Considerations . . . . . . . . . . . . . 36
7. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 36
7.1. XML Namespace . . . . . . . . . . . . . . . . . . . . . . 36
7.2. EPP Extension Registry . . . . . . . . . . . . . . . . . 37
7.3. Role Type Values Registry . . . . . . . . . . . . . . . . 37
7.3.1. Registration Template . . . . . . . . . . . . . . . . 37
7.3.2. Initial Registry Contents . . . . . . . . . . . . . . 38
8. Security Considerations . . . . . . . . . . . . . . . . . . . 38
9. References . . . . . . . . . . . . . . . . . . . . . . . . . 39
9.1. Normative References . . . . . . . . . . . . . . . . . . 39
9.2. Informative References . . . . . . . . . . . . . . . . . 40
Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . . . 41
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 411. Introduction ✨
okay so there are SO many entities in the domain registration world, like registrars, resellers, DNS service operators, and privacy proxies 🍓 and honestly? EPP never gave them a formal object. 😭 This document fixes that by letting you specify them as "organization" entities 💅
This document describes an organization object mapping for version 1.0 of the EPP [RFC5730]. The mapping is written in XML 1.0 as described in [W3C.REC-xml-20081126], and the XML Schema notation comes from [W3C.REC-xmlschema-1-20041028] and [W3C.REC-xmlschema-2-20041028]. 🦋
2. Conventions Used in This Document 🎀
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in BCP 14 [RFC2119] [RFC8174] when, and only when, they appear in all capitals, as shown here. 🔥
In examples, "C:" represents lines sent by a protocol client, and "S:" represents lines returned by a protocol server. Indentation and white space in examples are provided only to illustrate element relationships and are not a required feature of this specification. 🌸
XML is case sensitive. Unless stated otherwise, XML specifications and examples provided in this document MUST be interpreted in the character case presented. 💜
The XML namespace prefix "org" is used for the namespace "urn:ietf:params:xml:ns:epp:org-1.0", but implementations MUST NOT depend on it; instead, they should employ a proper namespace-aware XML parser and serializer to interpret and output the XML documents. 🧚
3. Object Attributes 🌈
An EPP organization object has attributes and associated values that can be viewed and modified by the sponsoring client or the server. This section describes each attribute type in detail. The formal syntax for the attribute values described here can be found in the "Formal Syntax" section of this document and in the appropriate normative references. 👑
3.1. Organization Identifier 🔑
All EPP organizations are identified by a server-unique identifier. Organization identifiers are character strings with a specified minimum length, a specified maximum length, and a specified format. Organization identifiers use the "clIDType" client identifier syntax described in [RFC5730]. The corresponding element is <org:id>. ✨
3.2. Organization Roles 🎭
The organization roles are used to represent the relationship an organization could have. The corresponding element is <org:role>. An organization object MUST always have at least one associated role. Roles can be set only by the client that sponsors an organization object. A client can change the role of an organization object using the EPP <update> command (see Section 4.2.5). 💅
3.2.1. Role Type 🏷️
An organization role MUST have a type field, which may have any of the values listed in Section 7.3. The corresponding element is <org:type>. An organization could have multiple roles with different role types. 🦋
3.2.2. Role Status 🌷
A role of an organization object MAY have its own statuses. The corresponding element is <org:status>. The possible values for the role status are defined in Section 3.5. 🎀
3.2.3. Role Identifier 🪪
A role MAY have a third-party-assigned identifier such as the IANA ID for registrars. The corresponding element is <org:roleID>. 💜
Example of organization role identifier:
<org:role>
<org:type>registrar</org:type>
<org:status>ok</org:status>
<org:status>linked</org:status>
<org:roleID>1362</org:roleID>
</org:role>3.3. Contact and Client Identifiers 🌈
All EPP contacts are identified by server-unique identifiers. Contact identifiers are character strings with a specified minimum length, a specified maximum length, and a specified format. Contact identifiers use the "clIDType" client identifier syntax described in [RFC5730]. 🫶
Part 2 of 7 is coming next, bestie. Keep your eyes peeled! 👀💖
3.4. Organization Status Values
Okay so every organization object MUST always have at least one associated status value 🎀 Status values can only be set by the client that sponsors the organization object, and by the server where the object lives 🏠 A client can change the status with the EPP <update> command ✨ Each status value MAY come with a little human-readable text explaining why it got applied 💬
A client MUST NOT alter server status values set by the server 🙅♀️ A server MAY alter or override status values set by a client, subject to local server policies 👑 The status of an object MAY change because of a client-initiated transform command or an action from a server operator 🦋
Status values a client can add or remove start with "client" 💅 The server versions that the server can add or remove start with "server" 🧚 The hold and terminated values are server managed when the organization has no parent identifier (Section 3.6), and otherwise MAY be client managed based on server policy 🌸 Any other status values that don't start with either "client" or "server" are server managed 💜
Status Value Descriptions:
ok: This is the normal status value for an object that has no operations pending or active prohibitions. The server sets and removes this value as other status values are added or removed 🌈hold: Organization transform commands and new links MUST be rejected 🛑terminated: The organization that has been terminated MUST NOT be linked. Organization transform commands and new links MUST be rejected 💀linked: The organization object has at least one active association with another object. The "linked" status is not explicitly set by the client. Servers should provide services to determine existing object associations 🔗clientLinkProhibited,serverLinkProhibited: Requests to add new links to the organization MUST be rejected 🙈clientUpdateProhibited,serverUpdateProhibited: Requests to update the object (other than to remove this status) MUST be rejected 🔒clientDeleteProhibited,serverDeleteProhibited: Requests to delete the object MUST be rejected 🚫pendingCreate,pendingUpdate,pendingDelete: A transform command has been processed for the object, but the server hasn't finished the action yet ⏳ Server operators can delay completing the action for lots of reasons, like letting a human review it or waiting on third-party action 🕵️♀️ A processed transform command whose requested action is still pending gets noted with response code 1001 📝
"pendingCreate", "ok", "hold", and "terminated" are mutually exclusive, which means they can't be friends 🙅♀️ An organization MUST have exactly one of these statuses set 💖
"ok" status MAY only be combined with "linked" status 💞
A client or server MAY combine "linked" with either "clientLinkProhibited" or "serverLinkProhibited" if new links must be prohibited 🔐
"pendingDelete" status MUST NOT be combined with either "clientDeleteProhibited" or "serverDeleteProhibited" status 🚷
The "pendingCreate", "pendingDelete", and "pendingUpdate" status values MUST NOT be combined with each other 🙃
If "clientUpdateProhibited" or "serverUpdateProhibited" is set, the client won't be able to update the object 😭 For "clientUpdateProhibited", the client will first need to remove "clientUpdateProhibited" before trying to update the object 🔑 The server can modify the object at any time 👑
3.5. Role Status Values
A role SHOULD have at least one associated status value ✨ Valid values include "ok", "linked", "clientLinkProhibited", and "serverLinkProhibited" 💜
Status Value Descriptions:
ok: This is the normal status value for a role that has no operations pending or active prohibitions. The server sets and removes this value as other status values are added or removed 🌸linked: The role of an organization object has at least one active association with another object. The "linked" status is not explicitly set by the client. Servers SHOULD provide services to determine existing object associations 🔗clientLinkProhibited,serverLinkProhibited: Requests to add new links to the role MUST be rejected 🙅♀️
3.6. Parent Identifier
Organizations can have more than one layer 🧁 The parent identifier, defined with the <org:parentId> element, is the parent organization identifier in a child organization 👶
The reseller situation is a great example 💅 The parent identifier isn't defined for the top-level reseller, which is the registrar of the registry 👑 An N-tier reseller has a parent reseller and at least one child reseller 🪜 A reseller customer has a parent reseller and no child resellers 🛍️
Loops MUST be prohibited 🔁 For example, if organization A has organization B as its parent identifier, then organization B can't have organization A as its parent identifier 🙅♀️ The same goes for bigger loops involving three or more organizations 🌀
3.7. URL
The URL is the organization's web home page, defined with the <org:url> element 🏡🌐
3.8. Dates and Times
Date and time attribute values MUST be represented in Coordinated Universal Time (UTC) using the Gregorian calendar 🕰️ The extended date-time form using uppercase "T" and "Z" characters, defined in [W3C.REC-xmlschema-2-20041028], MUST be used to represent date-time values 📅 That's because XML Schema doesn't support truncated date-time forms or lowercase "T" and "Z" characters 🙄
4. EPP Command Mapping
If you want the full scoop on EPP syntax and semantics, check out the EPP core protocol specification [RFC5730] 📖 The command mappings here are specifically for provisioning and managing organization information via EPP 💼
4.1. EPP Query Commands
EPP gives us two commands to retrieve organization information 🔍 The <check> command figures out if an organization object can be provisioned in a repository, and <info> retrieves detailed info about an organization object 🧾 This document doesn't define a mapping for the EPP <transfer> command to get organization-object transfer status info 🙅♀️
4.1.1. EPP <check> Command
The EPP <check> command is used to determine if an object can be provisioned in a repository 🔎 It gives the client a hint about whether a <create> will probably succeed or fail, but object-provisioning requirements are ultimately a matter of server policy 🤷♀️
In addition to the standard EPP command elements, the <check> command MUST contain an <org:check> element 💖 This element or its ancestor element MUST identify the organization namespace "urn:ietf:params:xml:ns:epp:org-1.0" 🏷️ The <org:check> element contains the following child elements:
- One or more
<org:id>elements that contain the server-unique identifier of the organization objects to be queried 🆔
Example <check> command:
C:<?xml version="1.0" encoding="UTF-8" standalone="no"?>
C:<epp xmlns="urn:ietf:params:xml:ns:epp-1.0">
C: <command>
C: <check>
C: <org:check
C: xmlns:org="urn:ietf:params:xml:ns:epp:org-1.0">
C: <org:id>res1523</org:id>
C: <org:id>re1523</org:id>
C: <org:id>1523res</org:id>
C: </org:check>
C: </check>
C: <clTRID>ABC-12345</clTRID>
C: </command>
C:</epp>When a <check> command has been processed successfully, the EPP <resData> element MUST contain a child <org:chkData> element 🎉 This element or its ancestor element MUST identify the organization namespace "urn:ietf:params:xml:ns:epp:org-1.0" 🏷️ The <org:chkData> element contains one or more <org:cd> elements, and each of those contains the following child elements:
- An
<org:id>element that identifies the queried object. This element MUST contain an "avail" attribute whose value shows object availability (whether it can be provisioned or not) at the moment the<check>command was completed 📊 A value of "1" or "true" means the object can be provisioned ✅ A value of "0" or "false" means it cannot be provisioned ❌ - An OPTIONAL
<org:reason>element that may be provided when an object cannot be provisioned 💬 If it's there, this element contains server-specific text explaining why the object can't be provisioned 🧐 This text MUST be represented in the response language previously negotiated with the client. An OPTIONAL "lang" attribute as defined in [RFC5646] may be present to identify the language if the negotiated value is something other than the default value of "en" (English) 🌍
Example <check> response:
S:<?xml version="1.0" encoding="UTF-8" standalone="no"?>
S:<epp xmlns="urn:ietf:params:xml:ns:epp-1.0">
S: <response>
S: <result code="1000">
S: <msg lang="en">Command completed successfully</msg>
S: </result>
S: <resData>
S: <org:chkData
S: xmlns:org="urn:ietf:params:xml:ns:epp:org-1.0">
S: <org:cd>
S: <org:id avail="1">res1523</org:id>
S: </org:cd>
S: <org:cd>
S: <org:id avail="0">re1523</org:id>
S: <org:reason lang="en">In use</org:reason>
S: </org:cd>
S: <org:cd>
S: <org:id avail="1">1523res</org:id>
S: </org:cd>
S: </org:chkData>
S: </resData>
S: <trID>
S: <clTRID>ABC-12345</clTRID>
S: <svTRID>54322-XYZ</svTRID>
S: </trID>
S: </response>
S:</epp>An EPP error response MUST be returned if a <check> command cannot be processed for any reason 🚨😭
4.1.2. EPP <info> Command 🔍
okay so the EPP <info> command is how you pull up everything about an organization object 🧚 The standard EPP command stuff is all there, but the <info> command MUST also contain an <org:info> element 💖. That element (or its ancestor) MUST identify the organization namespace "urn:ietf:params:xml:ns:epp:org-1.0". Inside <org:info> there's just one child:
- An
<org:id>element with the server-unique identifier of the organization object you want to look up 🎀
Here's a peek at an <info> command:
C:<?xml version="1.0" encoding="UTF-8" standalone="no"?>
C:<epp xmlns="urn:ietf:params:xml:ns:epp-1.0">
C: <command>
C: <info>
C: <org:info
C: xmlns:org="urn:ietf:params:xml:ns:epp:org-1.0">
C: <org:id>res1523</org:id>
C: </org:info>
C: </info>
C: <clTRID>ABC-12345</clTRID>
C: </command>
C:</epp>When an <info> command goes through successfully, the EPP <resData> element MUST contain a child <org:infData> element 🌸. That element or its ancestor MUST identify the organization namespace "urn:ietf:params:xml:ns:epp:org-1.0". The <org:infData> element can hold these children:
- An
<org:id>element with the server-unique identifier of the organization object, as defined in Section 3.1. - An
<org:roid>element with the Repository Object Identifier that got assigned to the organization object when it was created. - One or more
<org:role>elements with the role type, role statuses, and optional role ID of the organization 👑- An
<org:type>element with the type of the organization, as defined in Section 3.2. - One or more
<org:status>elements with the role statuses. The values of the role status are defined in Section 3.5. - An OPTIONAL
<org:roleID>element with a third-party-assigned identifier, such as IANA ID for registrars, as defined in Section 3.2.3.
- An
- One or more
<org:status>elements with the operational status of the organization, as defined in Section 3.4. - An OPTIONAL
<org:parentId>element with the identifier of the parent object, as defined in Section 3.6. - Zero to two
<org:postalInfo>elements with postal-address info. Two are allowed so the address can be given in both internationalized and localized forms, and a "type" attribute tells you which form is which. If an internationalized form (type="int") is provided, the element content MUST be represented in a subset of Unicode [UNICODE] in the range U+0020 - U+007E. If a localized form (type="loc") is provided, the element content MAY be represented in unrestricted UTF-8 🦋 The<org:postalInfo>element holds these children:- An
<org:name>element with the name of the organization. - An OPTIONAL
<org:addr>element with address info for the organization. An<org:addr>element contains these children:- One, two, or three
<org:street>elements with the organization's street address. - An
<org:city>element with the organization's city. - An OPTIONAL
<org:sp>element with the organization's state or province. - An OPTIONAL
<org:pc>element with the organization's postal code. - An
<org:cc>element with the alpha-2 organization's country code. The detailed format of this element is described in Section 2.4.3 of [RFC5733].
- One, two, or three
- An
- An OPTIONAL
<org:voice>element with the organization's voice telephone number. The detailed format of this element is described in Section 2.5 of [RFC5733]. - An OPTIONAL
<org:fax>element with the organization's facsimile telephone number. The detailed format of this element is described in Section 2.5 of [RFC5733]. - An OPTIONAL
<org:email>element with the organization's email address. The detailed format of this element is described in [RFC5322]. - An OPTIONAL
<org:url>element with the URL to the organization's website. The detailed format of this element is described in [RFC3986]. - Zero or more
<org:contact>elements with identifiers for the contact objects linked to the organization object. Contact object identifiers MUST be known to the server before the contact object can be linked to the organization object. The "type" attribute is required and tells you the contact type. The type values are "admin", "tech", "billing", "abuse", and "custom". The OPTIONAL "typeName" attribute is used to name a "custom" type 🧾 - An OPTIONAL
<org:clID>element with the organization identifier of the sponsoring client. There is no<org:clID>element if the organization is managed by the registry. - An
<org:crID>element with the identifier of the client that created the organization object. - An
<org:crDate>element with the date and time the organization object was created. - An
<org:upID>element with the identifier of the client that last updated the organization object. This element MUST NOT be present if the organization has never been modified. - An
<org:upDate>element with the date and time of the most recent modification to the organization object. This element MUST NOT be present if the organization object has never been modified.
Here's an <info> response for the "Example Registrar Inc." organization object with the identifier "registrar1362" 🏢
S:<?xml version="1.0" encoding="UTF-8" standalone="no"?>
S:<epp xmlns="urn:ietf:params:xml:ns:epp-1.0">
S: <response>
S: <result code="1000">
S: <msg lang="en">Command completed successfully</msg>
S: </result>
S: <resData>
S: <org:infData
S: xmlns:org="urn:ietf:params:xml:ns:epp:org-1.0">
S: <org:id>registrar1362</org:id>
S: <org:roid>registrar1362-REP</org:roid>
S: <org:role>
S: <org:type>registrar</org:type>
S: <org:status>ok</org:status>
S: <org:status>linked</org:status>
S: <org:roleID>1362</org:roleID>
S: </org:role>
S: <org:status>ok</org:status>
S: <org:postalInfo type="int">
S: <org:name>Example Registrar Inc.</org:name>
S: <org:addr>
S: <org:street>123 Example Dr.</org:street>
S: <org:street>Suite 100</org:street>
S: <org:city>Dulles</org:city>
S: <org:sp>VA</org:sp>
S: <org:pc>20166-6503</org:pc>
S: <org:cc>US</org:cc>
S: </org:addr>
S: </org:postalInfo>
S: <org:voice x="1234">+1.7035555555</org:voice>
S: <org:fax>+1.7035555556</org:fax>
S: <org:email>contact@organization.example</org:email>
S: <org:url>https://organization.example</org:url>
S: <org:contact type="admin">sh8013</org:contact>
S: <org:contact type="billing">sh8013</org:contact>
S: <org:contact type="custom"
S: typeName="legal">sh8013</org:contact>
S: <org:crID>ClientX</org:crID>
S: <org:crDate>2018-04-03T22:00:00.0Z</org:crDate>
S: <org:upID>ClientX</org:upID>
S: <org:upDate>2018-12-03T09:00:00.0Z</org:upDate>
S: </org:infData>
S: </resData>
S: <trID>
S: <clTRID>ABC-12345</clTRID>
S: <svTRID>54322-XYZ</svTRID>
S: </trID>
S: </response>
S:</epp>And here's an <info> response for the "Example Reseller Inc." organization object, a reseller type managed by "registrar1362" 🌈
S:<?xml version="1.0" encoding="UTF-8" standalone="no"?>
S:<epp xmlns="urn:ietf:params:xml:ns:epp-1.0">
S: <response>
S: <result code="1000">
S: <msg lang="en">Command completed successfully</msg>
S: </result>
S: <resData>
S: <org:infData
S: xmlns:org="urn:ietf:params:xml:ns:epp:org-1.0">
S: <org:id>reseller1523</org:id>
S: <org:roid>reseller1523-REP</org:roid>
S: <org:role>
S: <org:type>reseller</org:type>
S: <org:status>ok</org:status>
S: <org:status>linked</org:status>
S: </org:role>
S: <org:status>ok</org:status>
S: <org:parentId>registrar1362</org:parentId>
S: <org:postalInfo type="int">
S: <org:name>Example Reseller Inc.</org:name>
S: <org:addr>
S: <org:street>123 Example Dr.</org:street>
S: <org:street>Suite 100</org:street>
S: <org:city>Dulles</org:city>
S: <org:sp>VA</org:sp>
S: <org:pc>20166-6503</org:pc>
S: <org:cc>US</org:cc>
S: </org:addr>
S: </org:postalInfo>
S: <org:fax>+1.7035555556</org:fax>
S: <org:url>https://organization.example</org:url>
S: <org:contact type="admin">sh8013</org:contact>
S: <org:clID>1362</org:clID>
S: <org:crID>ClientX</org:crID>
S: <org:crDate>2018-04-03T22:00:00.0Z</org:crDate>
S: <org:upID>ClientX</org:upID>
S: <org:upDate>2018-12-03T09:00:00.0Z</org:upDate>
S: </org:infData>
S: </resData>
S: <trID>
S: <clTRID>ABC-12345</clTRID>
S: <svTRID>54322-XYZ</svTRID>
S: </trID>
S: </response>
S:</epp>If an <info> command can't be processed for any reason, an EPP error response MUST be returned 🚨
4.1.3. EPP <transfer> Query Command 🙈
transfer semantics don't apply to organization objects, so there's no EPP <transfer> query command defined in this document. not me going looking for one 💀
4.2. EPP Transform Commands ⚡
this document gives you three commands to transform organization object info: <create> to make an organization object, <delete> to delete one, and <update> to change the info attached to one 💅 It doesn't define a mapping for the EPP <transfer> or <renew> commands, so those are a no-go here.
Transform commands are usually processed and finished in real time ⏱️ Server operators MAY take in and process transform commands but hold off on finishing the requested action if it needs a human or a third party to review it first. In that case, the server MUST return a 1001 response code to the client, which basically says "got it, processed, but the action is still pending" 🫶 The server MUST also manage the status of the object the command is about, so it reflects when the action starts and when it wraps up. Once the action is done, the client MUST be notified with a service message saying the action is complete and the object's status has changed 🔔 Other notification methods MAY be used on top of that required service message ✨
4.2.1. EPP <create> Command 💅
Okay bestie, the EPP <create> command is the transform operation that lets a client make a brand-new organization object 🎀 Along with the usual EPP command elements, the <create> command MUST contain an <org:create> element. That element or its ancestor element MUST identify the organization namespace urn:ietf:params:xml:ns:epp:org-1.0. Inside <org:create> you'll find these child elements:
- An
<org:id>element with the server-unique identifier you want for the new organization, as defined in Section 3.1. - One or more
<org:role>elements that hold the role type, the role statuses, and an optional role ID.- An
<org:type>element with the type of the organization, as defined in Section 3.2. - Zero or more
<org:status>elements with the role statuses. The possible role status values are defined in Section 3.5. - An OPTIONAL
<org:roleID>element with a third-party-assigned identifier, like an IANA ID for registrars, as defined in Section 3.2.3.
- An
- Zero or more
<org:status>elements with the operational status of the organization, as defined in Section 3.4. - An OPTIONAL
<org:parentId>element with the identifier of the parent object, as defined in Section 3.6. - Zero to two
<org:postalInfo>elements with postal-address information 📬 You get two slots so the address can be given in both internationalized and localized forms, and a "type" attribute tells them apart. If an internationalized form (type="int") is provided, element content MUST be represented in a subset of Unicode [UNICODE] in the range U+0020 - U+007E. If a localized form (type="loc") is provided, element content MAY be represented in unrestricted UTF-8. The<org:postalInfo>element contains these child elements:- An
<org:name>element with the name of the organization. - An OPTIONAL
<org:addr>element with address information for the organization. An<org:addr>element contains these child elements:- One, two, or three
<org:street>elements with the organization's street address. - An
<org:city>element with the organization's city. - An OPTIONAL
<org:sp>element with the organization's state or province. - An OPTIONAL
<org:pc>element with the organization's postal code. - An
<org:cc>element with the alpha-2 country code. Its detailed format is described in Section 2.4.3 of [RFC5733].
- One, two, or three
- An
- An OPTIONAL
<org:voice>element with the organization's voice telephone number. Its detailed format is described in Section 2.5 of [RFC5733] 📞 - An OPTIONAL
<org:fax>element with the organization's facsimile telephone number. Its detailed format is described in Section 2.5 of [RFC5733]. - An OPTIONAL
<org:email>element with the organization's email address. Its detailed format is described of [RFC5322] (yes, "of", that's really what it says 🙈). - An OPTIONAL
<org:url>element with the URL to the organization's website. Its detailed format is described in [RFC3986]. - Zero or more
<org:contact>elements with identifiers for the contact objects associated with the organization object.
Here's an example <create> command, so you can see the whole outfit ✨
C:<?xml version="1.0" encoding="UTF-8" standalone="no"?>
C:<epp xmlns="urn:ietf:params:xml:ns:epp-1.0">
C: <command>
C: <create>
C: <org:create
C: xmlns:org="urn:ietf:params:xml:ns:epp:org-1.0">
C: <org:id>res1523</org:id>
C: <org:role>
C: <org:type>reseller</org:type>
C: </org:role>
C: <org:parentId>1523res</org:parentId>
C: <org:postalInfo type="int">
C: <org:name>Example Organization Inc.</org:name>
C: <org:addr>
C: <org:street>123 Example Dr.</org:street>
C: <org:street>Suite 100</org:street>
C: <org:city>Dulles</org:city>
C: <org:sp>VA</org:sp>
C: <org:pc>20166-6503</org:pc>
C: <org:cc>US</org:cc>
C: </org:addr>
C: </org:postalInfo>
C: <org:voice x="1234">+1.7035555555</org:voice>
C: <org:fax>+1.7035555556</org:fax>
C: <org:email>contact@organization.example</org:email>
C: <org:url>https://organization.example</org:url>
C: <org:contact type="admin">sh8013</org:contact>
C: <org:contact type="billing">sh8013</org:contact>
C: </org:create>
C: </create>
C: <clTRID>ABC-12345</clTRID>
C: </command>
C:</epp>When a <create> command has been processed successfully, the EPP <resData> element MUST contain a child <org:creData> element 🎉 That element or its ancestor element MUST identify the organization namespace urn:ietf:params:xml:ns:epp:org-1.0. The <org:creData> element contains these child elements:
- An
<org:id>element with the server-unique identifier for the created organization, as defined in Section 3.1. - An
<org:crDate>element with the date and time the organization object was created.
Here's what the success response looks like:
S:<?xml version="1.0" encoding="UTF-8" standalone="no"?>
S:<epp xmlns="urn:ietf:params:xml:ns:epp-1.0">
S: <response>
S: <result code="1000">
S: <msg lang="en">Command completed successfully</msg>
S: </result>
S: <resData>
S: <org:creData
S: xmlns:org="urn:ietf:params:xml:ns:epp:org-1.0">
S: <org:id>res1523</org:id>
S: <org:crDate>2018-04-03T22:00:00.0Z</org:crDate>
S: </org:creData>
S: </resData>
S: <trID>
S: <clTRID>ABC-12345</clTRID>
S: <svTRID>54321-XYZ</svTRID>
S: </trID>
S: </response>
S:</epp>An EPP error response MUST be returned if a <create> command cannot be processed for any reason. No exceptions, bestie 🚨
4.2.2. EPP <delete> Command 🗑️
The EPP <delete> command is the transform operation that lets a client delete an organization object. On top of the standard EPP command elements, the <delete> command MUST contain an <org:delete> element. That element or its ancestor element MUST identify the organization namespace urn:ietf:params:xml:ns:epp:org-1.0. The <org:delete> element MUST contain this child element:
- An
<org:id>element with the server-unique identifier of the organization object to be deleted, as defined in Section 3.1.
Now the drama 😭 An organization object MUST NOT be deleted if it is associated with other known objects. An associated organization MUST NOT be deleted until those associations with other known objects have been broken. A server MUST notify clients that object relationships exist by sending a 2305 error response code when a <delete> command is attempted and fails due to existing object relationships. Basically the server has to tell you "nope, you're still attached to stuff" with a 2305 🙅♀️
Here's an example <delete> command:
C:<?xml version="1.0" encoding="UTF-8" standalone="no"?>
C:<epp xmlns="urn:ietf:params:xml:ns:epp-1.0">
C: <command>
C: <delete>
C: <org:delete
C: xmlns:org="urn:ietf:params:xml:ns:epp:org-1.0">
C: <org:id>res1523</org:id>
C: </org:delete>
C: </delete>
C: <clTRID>ABC-12345</clTRID>
C: </command>
C:</epp>When a <delete> command has been processed successfully, a server MUST respond with an EPP response with no <resData> element 🫶
Here's the example <delete> response:
S:<?xml version="1.0" encoding="UTF-8" standalone="no"?>
S:<epp xmlns="urn:ietf:params:xml:ns:epp-1.0">
S: <response>
S: <result code="1000">
S: <msg lang="en">Command completed successfully</msg>
S: </result>
S: <trID>
S: <clTRID>ABC-12345</clTRID>
S: <svTRID>54321-XYZ</svTRID>
S: </trID>
S: </response>
S:</epp>An EPP error response MUST be returned if a <delete> command cannot be processed for any reason. Every single time, periodt 💀
4.2.3. EPP <renew> Command 🙅
Renewal semantics don't apply to organization objects, so there's no mapping defined for the EPP <renew> command. Nothing to renew here, bestie ✨
4.2.4. EPP <transfer> Command 🦋
Transfer semantics don't apply to organization objects either, so there's no mapping defined for the EPP <transfer> command. Same energy as renew: not happening for orgs 💜
4.2.5. EPP <update> Command ✨
okay bestie, the EPP <update> command is the glow-up move 💅. It's a transform operation that lets a client modify the attributes of an organization object. On top of the standard EPP command elements, the <update> command MUST contain an <org:update> element. That element, or one of its ancestors, MUST identify the organization namespace urn:ietf:params:xml:ns:epp:org-1.0. The <org:update> element holds these child elements:
- An
<org:id>element that contains the server-unique identifier of the organization object to be updated, as defined in Section 3.1. - An OPTIONAL
<org:add>element that contains attribute values to be added to the object. - An OPTIONAL
<org:rem>element that contains attribute values to be removed from the object. - An OPTIONAL
<org:chg>element that contains attribute values to be changed.
At least one <org:add>, <org:rem>, or <org:chg> element MUST be provided if the command is not being extended. All of these elements MAY be omitted if an <update> extension is present. The OPTIONAL <org:add> and <org:rem> elements contain these child elements:
- Zero or more
<org:contact>elements that contain the identifiers for contact objects to be associated with or removed from the organization object. Contact object identifiers MUST be known to the server before the contact object can be associated with the organization object. - Zero or more
<org:role>elements that contain the role type, role statuses, and optional role ID of the organization.- An
<org:type>element that contains the role type of the organization, as defined in Section 3.2. The role type uniquely identifies the role to update. - Zero or more
<org:status>elements that contain the role statuses. The values of the role status are defined in Section 3.5. - An OPTIONAL
<org:roleID>element that contains a third-party-assigned identifier, such as IANA ID for registrars, as defined in Section 3.2.3.
- An
- Zero or more
<org:status>elements that contain the operational status of the organization.
An OPTIONAL <org:chg> element contains these child elements, and at least one child element MUST be present:
- An OPTIONAL
<org:parentId>element that contains the identifier of the parent object. - Zero to two
<org:postalInfo>elements that contain postal-address information. Two elements are provided so that address information can be given in both internationalized and localized forms, and atypeattribute is used to tell the two forms apart. If an internationalized form (type="int") is provided, element content MUST be represented in a subset of Unicode [UNICODE] in the range U+0020 - U+007E. If a localized form (type="loc") is provided, element content MAY be represented in unrestricted UTF-8. The change of the postal info is defined as a replacement of that postal info element with the contents of the sub-elements included in the<update>command. An empty<org:postalInfo>element is supported to allow a type of postal info to be removed. The<org:postalInfo>element contains these child elements:- An
<org:name>element that contains the name of the organization. - An OPTIONAL
<org:addr>element that contains address information associated with the organization. An<org:addr>element contains these child elements:- One, two, or three
<org:street>elements that contain the organization's street address. - An
<org:city>element that contains the organization's city. - An OPTIONAL
<org:sp>element that contains the organization's state or province. - An OPTIONAL
<org:pc>element that contains the organization's postal code. - An
<org:cc>element that contains the alpha-2 organization's country code. The detailed format of this element is described in Section 2.4.3 of [RFC5733].
- One, two, or three
- An
- An OPTIONAL
<org:voice>element that contains the organization's voice telephone number. The detailed format of this element is described in Section 2.5 of [RFC5733]. - An OPTIONAL
<org:fax>element that contains the organization's facsimile telephone number. The detailed format of this element is described in Section 2.5 of [RFC5733]. - An OPTIONAL
<org:email>element that contains the organization's email address. The detailed format of this element is described in [RFC5322]. - An OPTIONAL
<org:url>element that contains the URL to the website of the organization. The detailed format of this element is described in [RFC3986].
Here's an example <update> command 🎀:
C:<?xml version="1.0" encoding="UTF-8" standalone="no"?>
C:<epp xmlns="urn:ietf:params:xml:ns:epp-1.0">
C: <command>
C: <update>
C: <org:update
C: xmlns:org="urn:ietf:params:xml:ns:epp:org-1.0">
C: <org:id>res1523</org:id>
C: <org:add>
C: <org:contact type="tech">sh8013</org:contact>
C: <org:role>
C: <org:type>privacyproxy</org:type>
C: <org:status>clientLinkProhibited</org:status>
C: </org:role>
C: <org:status>clientLinkProhibited</org:status>
C: </org:add>
C: <org:rem>
C: <org:contact type="billing">sh8014</org:contact>
C: <org:role>
C: <org:type>reseller</org:type>
C: </org:role>
C: </org:rem>
C: <org:chg>
C: <org:postalInfo type="int">
C: <org:addr>
C: <org:street>124 Example Dr.</org:street>
C: <org:street>Suite 200</org:street>
C: <org:city>Dulles</org:city>
C: <org:sp>VA</org:sp>
C: <org:pc>20166-6503</org:pc>
C: <org:cc>US</org:cc>
C: </org:addr>
C: </org:postalInfo>
C: <org:voice>+1.7034444444</org:voice>
C: <org:fax/>
C: </org:chg>
C: </org:update>
C: </update>
C: <clTRID>ABC-12345</clTRID>
C: </command>
C:</epp>When an <update> command has been processed successfully, a server MUST respond with an EPP response with no <resData> element. 🫶
Here's an example <update> response:
S:<?xml version="1.0" encoding="UTF-8" standalone="no"?>
S:<epp xmlns="urn:ietf:params:xml:ns:epp-1.0">
S: <response>
S: <result code="1000">
S: <msg lang="en">Command completed successfully</msg>
S: </result>
S: <trID>
S: <clTRID>ABC-12345</clTRID>
S: <svTRID>54321-XYZ</svTRID>
S: </trID>
S: </response>
S:</epp>An EPP error response MUST be returned if an <update> command cannot be processed for any reason. 😭
4.3. Offline Review of Requested Actions
okay so, commands get processed in the order a client sends them 📬. The server sends back an instant response confirming it got and processed the command, but a server operator MAY do an offline review of requested transform commands before the requested action is finished. When that happens, the server's response MUST clearly say that the transform command was received and processed, but that the requested action is pending. The status of the corresponding object in the response MUST clearly reflect that the pending action is being processed. The server MUST notify the client once the offline processing is complete. 🔥
Here are examples of a <create> command that needs offline review. Peep the result code and message in the response 👀.
S:<?xml version="1.0" encoding="UTF-8" standalone="no"?>
S:<epp xmlns="urn:ietf:params:xml:ns:epp-1.0">
S: <response>
S: <result code="1001">
S: <msg lang="en">Command completed successfully;
S: action pending</msg>
S: </result>
S: <resData>
S: <org:creData
S: xmlns:org="urn:ietf:params:xml:ns:epp:org-1.0">
S: <org:id>res1523</org:id>
S: <org:crDate>2018-04-03T22:00:00.0Z</org:crDate>
S: </org:creData>
S: </resData>
S: <trID>
S: <clTRID>ABC-12345</clTRID>
S: <svTRID>54321-XYZ</svTRID>
S: </trID>
S: </response>
S:</epp>After this response goes out, the status of the organization object MUST include pendingCreate. The server operator reviews the request offline and tells the client the outcome by queuing a service message for retrieval via the <poll> command. It MAY additionally use an out-of-band mechanism to inform the client of the outcome. 📨
The service message MUST contain text describing the notification in the child <msg> element of the response <msgQ> element. On top of that, the EPP <resData> element MUST contain a child <org:panData> element. That element, or one of its ancestors, MUST identify the organization namespace urn:ietf:params:xml:ns:epp:org-1.0. The <org:panData> element contains these child elements:
- An
<org:id>element that contains the server-unique identifier of the organization object. The<org:id>element contains a REQUIREDpaResultattribute. A positive boolean value means the request has been approved and completed. A negative boolean value means the request has been denied and the requested action has not been taken. - An
<org:paTRID>element that contains the client transaction identifier and server transaction identifier returned with the original response to process the command. The client transaction identifier is OPTIONAL and will only be returned if the client provided an identifier with the original<create>command. - An
<org:paDate>element that contains the date and time describing when review of the requested action was completed.
Here's an example "review completed" service message 🎉:
S:<?xml version="1.0" encoding="UTF-8" standalone="no"?>
S:<epp xmlns="urn:ietf:params:xml:ns:epp-1.0">
S: <response>
S: <result code="1301">
S: <msg lang="en">Command completed successfully;
S: ack to dequeue</msg>
S: </result>
S: <msgQ count="5" id="12345">
S: <qDate>2018-04-04T22:01:00.0Z</qDate>
S: <msg>Pending action completed successfully.</msg>
S: </msgQ>
S: <resData>
S: <org:panData
S: xmlns:org="urn:ietf:params:xml:ns:epp:org-1.0">
S: <org:id paResult="1">res1523</org:id>
S: <org:paTRID>
S: <clTRID>ABC-12345</clTRID>
S: <svTRID>54321-XYZ</svTRID>
S: </org:paTRID>
S: <org:paDate>2018-04-04T22:00:00.0Z</org:paDate>
S: </org:panData>
S: </resData>
S: <trID>
S: <clTRID>BCD-23456</clTRID>
S: <svTRID>65432-WXY</svTRID>
S: </trID>
S: </response>
S:</epp>5. Formal Syntax ✨
okay this is the part where the schema comes out to play 🧚. The EPP object mapping is written in XML Schema notation. The schema shown here is a complete representation of the object mapping, made for automated validation of EPP XML instances. The BEGIN and END tags aren't part of the schema. They just mark where it starts and ends, for URI registration purposes 💜.
BEGIN
<?xml version="1.0" encoding="UTF-8"?>okay so we're still deep in the schema, bestie 💅🎀 this chunk is all about the org namespace: the statuses, roles, postal info, contacts, and the <check> and <info> response shapes. it's giving organized chaos ✨
<schema targetNamespace="urn:ietf:params:xml:ns:epp:org-1.0"
xmlns:org="urn:ietf:params:xml:ns:epp:org-1.0"
xmlns:epp="urn:ietf:params:xml:ns:epp-1.0"
xmlns:eppcom="urn:ietf:params:xml:ns:eppcom-1.0"
xmlns="http://www.w3.org/2001/XMLSchema"
elementFormDefault="qualified">
<!--
Import common element types.
-->
<import namespace="urn:ietf:params:xml:ns:eppcom-1.0"/>
<import namespace="urn:ietf:params:xml:ns:epp-1.0"/>
<annotation>
<documentation>
Extensible Provisioning Protocol v1.0
organization provisioning schema.
</documentation>
</annotation>
<!--
Child elements found in EPP commands.
-->
<element name="create" type="org:createType"/>
<element name="delete" type="org:sIDType"/>
<element name="update" type="org:updateType"/>
<element name="check" type="org:mIDType"/>
<element name="info" type="org:infoType"/>
<element name="panData" type="org:panDataType"/>
<!--
Utility types.
-->
<simpleType name="statusType">
<restriction base="token">
<enumeration value="ok"/>
<enumeration value="hold"/>
<enumeration value="terminated"/>
<enumeration value="clientDeleteProhibited"/>
<enumeration value="clientUpdateProhibited"/>
<enumeration value="clientLinkProhibited"/>
<enumeration value="linked"/>
<enumeration value="pendingCreate"/>
<enumeration value="pendingUpdate"/>
<enumeration value="pendingDelete"/>
<enumeration value="serverDeleteProhibited"/>
<enumeration value="serverUpdateProhibited"/>
<enumeration value="serverLinkProhibited"/>
</restriction>
</simpleType>
<simpleType name="roleStatusType">
<restriction base="token">
<enumeration value="ok"/>
<enumeration value="clientLinkProhibited"/>
<enumeration value="linked"/>
<enumeration value="serverLinkProhibited"/>
</restriction>
</simpleType>
<complexType name="roleType">
<sequence>
<element name="type" type="token"/>
<element name="status" type="org:roleStatusType"
minOccurs="0" maxOccurs="3"/>
<element name="roleID" type="token" minOccurs="0"/>
</sequence>
</complexType>
<complexType name="postalInfoType">
<sequence>
<element name="name"
type="org:postalLineType"/>
<element name="addr"
type="org:addrType" minOccurs="0"/>
</sequence>
<attribute name="type"
type="org:postalInfoEnumType"
use="required"/>
</complexType>
<complexType name="contactType">
<simpleContent>
<extension base="eppcom:clIDType">
<attribute name="type" type="org:contactAttrType"
use="required"/>
<attribute name="typeName" type="token"/>
</extension>
</simpleContent>
</complexType>
<simpleType name="contactAttrType">
<restriction base="token">
<enumeration value="admin"/>
<enumeration value="billing"/>
<enumeration value="tech"/>
<enumeration value="abuse"/>
<enumeration value="custom"/>
</restriction>
</simpleType>
<complexType name="e164Type">
<simpleContent>
<extension base="org:e164StringType">
<attribute name="x" type="token"/>
</extension>
</simpleContent>
</complexType>
<simpleType name="e164StringType">
<restriction base="token">
<pattern value="(\+[0-9]{1,3}\.[0-9]{1,14})?"/>
<maxLength value="17"/>
</restriction>
</simpleType>
<simpleType name="postalLineType">
<restriction base="normalizedString">
<minLength value="1"/>
<maxLength value="255"/>
</restriction>
</simpleType>
<simpleType name="optPostalLineType">
<restriction base="normalizedString">
<maxLength value="255"/>
</restriction>
</simpleType>
<simpleType name="pcType">
<restriction base="token">
<maxLength value="16"/>
</restriction>
</simpleType>
<simpleType name="ccType">
<restriction base="token">
<length value="2"/>
</restriction>
</simpleType>
<complexType name="addrType">
<sequence>
<element name="street" type="org:optPostalLineType"
minOccurs="0" maxOccurs="3"/>
<element name="city" type="org:postalLineType"/>
<element name="sp" type="org:optPostalLineType"
minOccurs="0"/>
<element name="pc" type="org:pcType"
minOccurs="0"/>
<element name="cc" type="org:ccType"/>
</sequence>
</complexType>
<simpleType name="postalInfoEnumType">
<restriction base="token">
<enumeration value="loc"/>
<enumeration value="int"/>
</restriction>
</simpleType>
<!--
Child element of commands that require only an identifier.
-->
<complexType name="sIDType">
<sequence>
<element name="id" type="eppcom:clIDType"/>
</sequence>
</complexType>
<!--
Child element of commands that accept multiple identifiers.
-->
<complexType name="mIDType">
<sequence>
<element name="id"
type="eppcom:clIDType" maxOccurs="unbounded"/>
</sequence>
</complexType>
<!--
Pending action notification response elements.
-->
<complexType name="panDataType">
<sequence>
<element name="id" type="org:paCLIDType"/>
<element name="paTRID" type="epp:trIDType"/>
<element name="paDate" type="dateTime"/>
</sequence>
</complexType>
<complexType name="paCLIDType">
<simpleContent>
<extension base="eppcom:clIDType">
<attribute name="paResult" type="boolean"
use="required"/>
</extension>
</simpleContent>
</complexType>
<!--
Child elements of the <info> commands.
-->
<complexType name="infoType">
<sequence>
<element name="id"
type="eppcom:clIDType"/>
</sequence>
</complexType>
<!--
Child elements of the <create> command.
-->
<complexType name="createType">
<sequence>
<element name="id"
type="eppcom:clIDType"/>
<element name="role"
type="org:roleType" maxOccurs="unbounded"/>
<element name="status"
type="org:statusType" minOccurs="0" maxOccurs="4"/>
<element name="parentId"
type="eppcom:clIDType" minOccurs="0"/>
<element name="postalInfo"
type="org:postalInfoType" minOccurs="0" maxOccurs="2"/>
<element name="voice"
type="org:e164Type" minOccurs="0"/>
<element name="fax"
type="org:e164Type" minOccurs="0"/>
<element name="email"
type="eppcom:minTokenType" minOccurs="0"/>
<element name="url"
type="anyURI" minOccurs="0"/>
<element name="contact"
type="org:contactType"
minOccurs="0" maxOccurs="unbounded"/>
</sequence>
</complexType>
<!--
Child elements of the <update> command.
-->
<complexType name="updateType">
<sequence>
<element name="id"
type="eppcom:clIDType"/>
<element name="add"
type="org:addRemType" minOccurs="0"/>
<element name="rem"
type="org:addRemType" minOccurs="0"/>
<element name="chg"
type="org:chgType" minOccurs="0"/>
</sequence>
</complexType>
<!--
Data elements that can be added or removed.
-->
<complexType name="addRemType">
<sequence>
<element name="contact"
type="org:contactType" minOccurs="0"
maxOccurs="unbounded"/>
<element name="role" type="org:roleType"
minOccurs="0" maxOccurs="unbounded"/>
<element name="status" type="org:statusType"
minOccurs="0" maxOccurs="9"/>
</sequence>
</complexType>
<!--
Data elements that can be changed.
-->
<complexType name="chgType">
<sequence>
<element name="parentId"
type="eppcom:clIDType" minOccurs="0"/>
<element name="postalInfo"
type="org:chgPostalInfoType"
minOccurs="0" maxOccurs="2"/>
<element name="voice"
type="org:e164Type" minOccurs="0"/>
<element name="fax"
type="org:e164Type" minOccurs="0"/>
<element name="email"
type="eppcom:minTokenType" minOccurs="0"/>
<element name="url"
type="anyURI" minOccurs="0"/>
</sequence>
</complexType>
<complexType name="chgPostalInfoType">
<sequence>
<element name="name"
type="org:postalLineType" minOccurs="0"/>
<element name="addr"
type="org:addrType" minOccurs="0"/>
</sequence>
<attribute name="type"
type="org:postalInfoEnumType" use="required"/>
</complexType>
<!--
Child response elements.
-->
<element name="chkData" type="org:chkDataType"/>
<element name="creData" type="org:creDataType"/>
<element name="infData" type="org:infDataType"/>
<!--
<check> response elements.
-->
<complexType name="chkDataType">
<sequence>
<element name="cd" type="org:checkType"
maxOccurs="unbounded" />
</sequence>
</complexType>
<complexType name="checkType">
<sequence>
<element name="id" type="org:checkIDType"/>
<element name="reason" type="eppcom:reasonType"
minOccurs="0"/>
</sequence>
</complexType>
<complexType name="checkIDType">
<simpleContent>
<extension base="eppcom:clIDType">
<attribute name="avail" type="boolean"
use="required"/>
</extension>
</simpleContent>
</complexType>
<!--
<info> response elements.
-->
<complexType name="infDataType">
<sequence>
<element name="id"
type="eppcom:clIDType"/>
<element name="roid"
type="eppcom:roidType"/>
<element name="role"
type="org:roleType" maxOccurs="unbounded"/>
<element name="status"
type="org:statusType" maxOccurs="9"/>more schema is coming next, the best part is still ahead 👀🦋
<element name="parentId"
type="eppcom:clIDType" minOccurs="0"/>
<element name="postalInfo"
type="org:postalInfoType" minOccurs="0" maxOccurs="2"/>
<element name="voice"
type="org:e164Type" minOccurs="0"/>
<element name="fax"
type="org:e164Type" minOccurs="0"/>
<element name="email"
type="eppcom:minTokenType" minOccurs="0"/>
<element name="url"
type="anyURI" minOccurs="0"/>
<element name="contact"
type="org:contactType" minOccurs="0"
maxOccurs="unbounded"/>
<element name="clID"
type="eppcom:clIDType" minOccurs="0"/>
<element name="crID"
type="eppcom:clIDType"/>
<element name="crDate"
type="dateTime"/>
<element name="upID"
type="eppcom:clIDType" minOccurs="0"/>
<element name="upDate"
type="dateTime" minOccurs="0"/>
</sequence>
</complexType>
<!--
<create> response elements.
-->
<complexType name="creDataType">
<sequence>
<element name="id" type="eppcom:clIDType"/>
<element name="crDate" type="dateTime"/>
</sequence>
</complexType>
<!--
End of schema.
-->
</schema>
END6. Internationalization Considerations 🌈
EPP is written in XML, and XML is seriously good at handling characters 💅. It has native support for the Unicode character set [UNICODE] and its more compact forms, including UTF-8. Conformant XML processors recognize both UTF-8 [RFC3629] and UTF-16 [RFC2781]. XML even lets you pick a different character encoding through an "encoding" attribute in an <?xml?> declaration, but using UTF-8 is RECOMMENDED 💖.
As an extension of the EPP organization object mapping, the elements and element content described in this document MUST inherit the internationalization conventions used to represent higher-layer domain and core protocol structures, in any XML instance that includes this extension ✨.
7. IANA Considerations 🎀
7.1. XML Namespace
This document uses URNs to describe XML namespaces and XML schemas that follow a registry mechanism described in [RFC3688]. IANA has assigned the following URIs, so here they are 🦋.
The organization namespace:
URI: urn:ietf:params:xml:ns:epp:org-1.0
Registrant Contact: IESG
XML: None. Namespace URIs do not represent an XML specification.
The organization XML schema:
URI: urn:ietf:params:xml:schema:epp:org-1.0
Registrant Contact: IESG
XML: See the "Formal Syntax" section of RFC 8543 (this document).7.2. EPP Extension Registry
IANA has registered this EPP extension in the "Extensions for the Extensible Provisioning Protocol (EPP)" registry described in [RFC7451]. Here are the registration details, all neatly lined up 🍓:
Name of Extension: Extensible Provisioning Protocol (EPP)
Organization Mapping
Document status: Standards Track
Reference: RFC 8543
Registrant Name and Email Address: IESG, iesg@ietf.org
TLDs: Any
IPR Disclosure: None
Status: Active
Notes: None7.3. Role Type Values Registry
IANA has created a brand new category of protocol registry for values of the organization roles 🧚. It's called "EPP Organization Role Values", and the registration policy for it is "Expert Review" [RFC8126]. Main character registry era 👑.
7.3.1. Registration Template
Value: The string value being registered.
Description: Brief description of the organization role values.
Registrant Name: For RFC specifications, state "IESG". For other
specifications, give the name of the responsible party.
Registrant Contact Information: An email address, postal address, or
some other information to be used to contact the registrant.7.3.2. Initial Registry Contents
These are the starter values the registry comes with 🌸:
Value: registrar
Description: The entity object instance represents the authority
responsible for the registration in the registry.
Registrant: IESG, iesg@ietf.org
Value: reseller
Description: The entity object instance represents a third party
through which the registration was conducted (i.e., not the
registry or registrar).
Registrant: IESG, iesg@ietf.org
Value: privacyproxy
Description: The entity object instance represents a third party
who could help to register a domain without exposing the
registrants' private information.
Registrant: IESG, iesg@ietf.org
Value: dns-operator
Description: The entity object instance represents a third-party
DNS operator that maintains the name servers and zone data on
behalf of a registrant.
Registrant: IESG, iesg@ietf.org8. Security Considerations 🚨
Okay, bestie, this part is serious 😭. The organization object can have personally identifiable information in it, like <org:contact>. That info is not a required element in this document, so it's only there on a voluntary basis 🙈. If it does get provided, then both client and server MUST make sure that authorization information is stored and exchanged with high-grade encryption mechanisms so the privacy services work, which are specified in [RFC5733]. And the security considerations in [RFC5730], plus anything caused by the protocol layers EPP runs on, apply to this specification too 🔐💀.
9. References
9.1. Normative References
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", BCP 14, RFC 2119,
DOI 10.17487/RFC2119, March 1997,
<https://www.rfc-editor.org/info/rfc2119>.
[RFC3629] Yergeau, F., "UTF-8, a transformation format of ISO
10646", STD 63, RFC 3629, DOI 10.17487/RFC3629, November
2003, <https://www.rfc-editor.org/info/rfc3629>.
[RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688,
DOI 10.17487/RFC3688, January 2004,
<https://www.rfc-editor.org/info/rfc3688>.
[RFC3986] Berners-Lee, T., Fielding, R., and L. Masinter, "Uniform
Resource Identifier (URI): Generic Syntax", STD 66,
RFC 3986, DOI 10.17487/RFC3986, January 2005,
<https://www.rfc-editor.org/info/rfc3986>.
[RFC5322] Resnick, P., Ed., "Internet Message Format", RFC 5322,
DOI 10.17487/RFC5322, October 2008,
<https://www.rfc-editor.org/info/rfc5322>.
[RFC5646] Phillips, A., Ed. and M. Davis, Ed., "Tags for Identifying
Languages", BCP 47, RFC 5646, DOI 10.17487/RFC5646,
September 2009, <https://www.rfc-editor.org/info/rfc5646>.
[RFC5730] Hollenbeck, S., "Extensible Provisioning Protocol (EPP)",
STD 69, RFC 5730, DOI 10.17487/RFC5730, August 2009,
<https://www.rfc-editor.org/info/rfc5730>.
[RFC5733] Hollenbeck, S., "Extensible Provisioning Protocol (EPP)
Contact Mapping", STD 69, RFC 5733, DOI 10.17487/RFC5733,
August 2009, <https://www.rfc-editor.org/info/rfc5733>.
[RFC8126] Cotton, M., Leiba, B., and T. Narten, "Guidelines for
Writing an IANA Considerations Section in RFCs", BCP 26,
RFC 8126, DOI 10.17487/RFC8126, June 2017,
<https://www.rfc-editor.org/info/rfc8126>.
[RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC
2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174,
May 2017, <https://www.rfc-editor.org/info/rfc8174>.
[UNICODE] The Unicode Consortium, "The Unicode Standard",
<http://www.unicode.org/versions/latest/>.
[W3C.REC-xml-20081126]
Bray, T., Paoli, J., Sperberg-McQueen, C., Maler, E., and
F. Yergeau, "Extensible Markup Language (XML) 1.0 (Fifth
Edition)", World Wide Web Consortium Recommendation
REC-xml-20081126, November 2008,
<https://www.w3.org/TR/xml/>.
[W3C.REC-xmlschema-1-20041028]
Thompson, H., Beech, D., Maloney, M., and N. Mendelsohn,
"XML Schema Part 1: Structures Second Edition", World Wide
Web Consortium Recommendation REC-xmlschema-1-20041028,
October 2004,
<http://www.w3.org/TR/2004/REC-xmlschema-1-20041028>.
[W3C.REC-xmlschema-2-20041028]
Biron, P. and A. Malhotra, "XML Schema Part 2: Datatypes
Second Edition", World Wide Web Consortium Recommendation
REC-xmlschema-2-20041028, October 2004,
<http://www.w3.org/TR/2004/REC-xmlschema-2-20041028>.9.2. Informative References
[RFC2781] Hoffman, P. and F. Yergeau, "UTF-16, an encoding of ISO
10646", RFC 2781, DOI 10.17487/RFC2781, February 2000,
<https://www.rfc-editor.org/info/rfc2781>.
[RFC7451] Hollenbeck, S., "Extension Registry for the Extensible
Provisioning Protocol", RFC 7451, DOI 10.17487/RFC7451,
February 2015, <https://www.rfc-editor.org/info/rfc7451>.Acknowledgments 🫶
Huge thanks to Rik Ribbers, Marc Groeneweg, Patrick Mevzek, Antoin Verschuren, and Scott Hollenbeck for their careful review and valuable comments. Iconic behaviour from all of you 👑✨.
Authors' Addresses
Linlin Zhou
CNNIC
4 South 4th Street, Zhongguancun, Haidian District
Beijing, Beijing 100190
China
Email: zhoulinlin@cnnic.cn
Ning Kong
Consultant
Email: ietfing@gmail.com
Jiankang Yao
CNNIC
4 South 4th Street, Zhongguancun, Haidian District
Beijing, Beijing 100190
China
Email: yaojk@cnnic.cn
James Gould
VeriSign, Inc.
12061 Bluemont Way
Reston, VA 20190
United States of America
Email: jgould@verisign.com
URI: http://www.verisign.com
Guiqing Zhou
Email: qing.joe@gmail.com📦 where this page comes from
- ietf: rfc8543 2019-03
- 💖 girlified by claude-haiku-5-5 on : a language model's rewrite of the original, under its terms