The login command is used to establish and authenticate a session with the EPP server. The login command must be sent to the server before any other EPP command and identifies and authenticates the tag to be used by the session. An EPP session is terminated by a logout command.

<epp:login> element

The <epp:login> element contains the following child elements:

• A <epp:clID> element that contains the tag. See the note below for 2 character tags.
  
• A <epp:pw> element that contains the EPP password for the tag. 
• An optional <epp:newPW> element that contains a new password to be used for subsequent login commands.
• An <epp:options> element that containing the following child elements:
  • A <epp:version> element containing the protocol version to be used. Currently, this must be 1.0
  • A <epp:lang> element that contains the text response language to be used. Currently, this must be en.
    
• A <epp:svcs> element containing:
  • <epp:objURI> elements which contain the namespace URIs for the objects to be used during the session. Further details on the namespace URIs are available.  It is necessary to declare the schemas for all the objects that will be manipulated during the session.
    
  • An optional <epp:svcExtension> element containing:
    • <epp:extURI> elements which contain namespace extension URIs.  It is necessary to declare the schema extensions for all the objects that will be manipulated during the session.

Note: If 'epp' is set as the default namespace then the 'epp:' prefix can be omitted.

2 character tags

Examples

Logging in

<?xml version="1.0" encoding="UTF-8"?>
  <epp xmlns="urn:ietf:params:xml:ns:epp-1.0" 
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
       xsi:schemaLocation="urn:ietf:params:xml:ns:epp-1.0 epp-1.0.xsd">
    <command>
      <login>
        <clID>EXAMPLE-TAG</clID>
        <pw>foo-123</pw>
        <options>
          <version>1.0</version>
          <lang>en</lang>
        </options>
        <svcs>
           <objURI>urn:ietf:params:xml:ns:domain-1.0</objURI>
           <objURI>urn:ietf:params:xml:ns:contact-1.0</objURI>
           <objURI>urn:ietf:params:xml:ns:host-1.0</objURI>
        </svcs>
      </login>
      <clTRID>ABC-12345</clTRID>
    </command>
  </epp>

This is an example of a log in request where standard and extension schemas have been declared.

<?xml version="1.0" encoding="UTF-8"?>
  <epp xmlns="urn:ietf:params:xml:ns:epp-1.0" 
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
       xsi:schemaLocation="urn:ietf:params:xml:ns:epp-1.0 epp-1.0.xsd">
    <command>
      <login>
        <clID>EXAMPLE-TAG</clID>
        <pw>foo-123</pw>
        <options>
          <version>1.0</version>
          <lang>en</lang>
        </options>
        <svcs>
           <objURI>urn:ietf:params:xml:ns:domain-1.0</objURI>
           <objURI>urn:ietf:params:xml:ns:contact-1.0</objURI>
           <objURI>urn:ietf:params:xml:ns:host-1.0</objURI>
           <svcExtension>
             <extURI>http://www.nominet.org.uk/epp/xml/contact-nom-ext-1.0</extURI>
             <extURI>http://www.nominet.org.uk/epp/xml/domain-nom-ext-1.0</extURI>
           </svcExtension>
        </svcs>
      </login>
      <clTRID>ABC-12345</clTRID>
    </command>
  </epp>

Logging in and changing the password for next time

<?xml version="1.0" encoding="UTF-8"?>
  <epp xmlns="urn:ietf:params:xml:ns:epp-1.0" 
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
       xsi:schemaLocation="urn:ietf:params:xml:ns:epp-1.0 epp-1.0.xsd">
    <command>
      <login>
        <clID>EXAMPLE-TAG</clID>
        <pw>foo-123</pw>
        <newPW>foo-321</newPW>
        <options>
          <version>1.0</version>
          <lang>en</lang>
        </options>
        <svcs>
           <objURI>urn:ietf:params:xml:ns:domain-1.0</objURI>
           <objURI>urn:ietf:params:xml:ns:contact-1.0</objURI>
           <objURI>urn:ietf:params:xml:ns:host-1.0</objURI>
        </svcs>
      </login>
      <clTRID>ABC-12345</clTRID>
    </command>
  </epp>

Response from logging in

<?xml version="1.0" encoding="UTF-8"?>
 <epp xmlns="urn:ietf:params:xml:ns:epp-1.0"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xsi:schemaLocation="urn:ietf:params:xml:ns:epp-1.0
      epp-1.0.xsd">
   <response>
     <result code="1000">
       <msg>Command completed successfully</msg>
     </result>
     <trID>
       <clTRID>ABC-12345</clTRID>
       <svTRID>54321-XYZ</svTRID>
     </trID>
   </response>
 </epp>