Login[Link]

Purpose

To authenticate the client to the EPP server. It must be sent before any other command (except <hello>).

This command is used to establish the registrar credentials. The userid and EPP password will be used to authenticate the party that wants to set up the session.

The login command is composed according to the standard EPP syntax. Some components need further explanation:

  • <clID> Contains the registrar ID of the connecting client.

  • <pw> Contains the EPP password of the connecting client (registrar). This is the password that you have to provide when you activate your account at the start of your contract.

  • <newPW> is not supported by DNS Belgium. If you want to change your password, you can do this on My registrations.

  • <version> Contains the EPP version the client support (1.0). This will be used for versioning (on EPP standard level) in the future.

  • <lang> Contains the preferred language of the client for this connection (actually ignored by DNS Belgium). Both <version> and <lang> must match one of the server proposition(s).

  • <svcs> Contains a list of <objURI> and <extURI> the client wants to use with the EPP server during this connection.

  • <clTRID> Each transaction can be completed with a user provided transaction ID, that can be used to identify a transaction.

An EPP connection is kept open by the server between a <login> and a <logout> command from the client, using the same socket connection. The EPP connection is closed without logout if the client closes the socket. However, to ensure responsible behaviour a client should disconnect the socket only after the EPP <logout> command.

If you want to receive secDNS information in any of the responses to your transactions, you need to specify that extension in your login command at the <svcs> level. We recommend that you specify all <objURI> and <extURI> you want to use during your session.

Examples[Link]

Minimal login:

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<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>dns-as-agent</clID>
      <pw>mypassword</pw>
      <options>
        <version>0.9</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>
      </svcs>
    </login>
  </command>
</epp>

Full login (recommended):

<?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>dns-as-agent</clID>
  <pw>mypassword</pw>
  <options>
    <version>1.0</version>
    <lang>en</lang>
  </options>
  <svcs>
    <objURI>urn:ietf:params:xml:ns:contact-1.0</objURI>
    <objURI>urn:ietf:params:xml:ns:domain-1.0</objURI>
    <svcExtension>
     <extURI>http://www.dns.be/xml/epp/dnsbe-1.0</extURI>
     <extURI>http://www.dns.be/xml/epp/nsgroup-1.0</extURI>
     <extURI>http://www.dns.be/xml/epp/keygroup-1.0</extURI>
     <extURI>urn:ietf:params:xml:ns:secDNS-1.1</extURI>
    </svcExtension>
  </svcs>
</login>
<clTRID>clientref-00001</clTRID>
</command>
</epp>

The server responds to a <login> command with a result code of 1000 (“Command completed successfully”) or 2200 (“Authentication error”):

<?xml version="1.0" encoding="UTF-8"?>
<epp xmlns="urn:ietf:params:xml:ns:epp-1.0" xmlns:dnsbe="http://www.dns.be/xml/epp/dnsbe-1.0">
  <response>
    <result code="1000">
      <msg>Command completed successfully</msg>
    </result>
    <extension>
      <dnsbe:ext>
        <dnsbe:result>
          <dnsbe:msg>login succeeded</dnsbe:msg>
        </dnsbe:result>
      </dnsbe:ext>
    </extension>
    <trID>
      <clTRID>clientref-00001</clTRID>
      <svTRID>dnsbe-0</svTRID>
    </trID>
  </response>
</epp>

Note

As long as no <login> command has been processed successfully, the server will reply with error code 2202 to all commands except <hello>.