System Status
System Status

ZA logging In/Out

Logging in

Login Command

  1. The <login> element specifies that a login command is being attempted.
  2. Within the <login> element, various child elements must be included.
  3. The <clID> must be populated. The <clID> element references the registrar’s ID that was given as part of the Live Credentials.
  4. The <pw> element must be populated with the registrar’s password.
  5. The <version> element refers to the version of the XML schema to be used. co.za will inform registrars of schema version changes if the schema version is increased.
  6. The <lang> element specifies the language to be used. For most registrars this will be en indicating English.
  7. The <svcs> element will include which services the registrar wants to access. In the <objURI> element, the service can be specified. Available services will be made available to registrars.
  8. The <clTRID> element must be populated with a unique identifier. The length of the identifier must be a minimum of 3 characters and a maximum of 64 characters. For every login, the <clTRID> must be populated with a new identifier to avoid idempotentcy.

Possible Responses

This section identifies the possible responses from the server when attempting to log in.

1000: Access Granted

A response code of 1000 means that the command was sent through successfully and that access has been granted to the system.

2501: Incorrect Credentials

A response code of 2501 means that the provided credentials were incorrect. To rectify this please review the provided information in the <cLID> and <pw> elements.

2307: Accessing Services That Are Unavailable

A result code of 2307 means that services that are not available to the registrar on the server were trying to be accessed. To rectify this, review the available services  within the <svcs>/<objURI> element. All available services on the server may be obtained through an EPP Hello Command.

2202: Already Authenticated

A result code of 2002 means that there is already a session running and that a Login is not required. To rectify this, either Logout after each command or run commands within the session without attemting a login.

Logging Out

Command

To log out of the system, an EPP Logout command has to be issued to the server. To achieve this, the <logout/> element has to be included within the <command> element. The <logout/> element does not require any further information.

The final required element is the <clTRID> element. Within this element, a unique string must be specified. The string must be a minimum of 3 characters and a maximum of 64.

1500: Logout Successful

If the request was sent through correctly, the server will respond with a result code of 1500. This means the logout was successful.

Change password

Changing Password on login

The login password may be changed through the login command by including the <newPW> as outlined below. If a successful login is performed, the new password will be applied at the end of the current session.

NOTE: The length of the password may not be longer than 16 ASCII characters.