Date: Fri, 29 Mar 2024 09:34:47 +0100 (CET) Message-ID: <724367623.3893.1711701287679@de.help.internetx.com> Subject: Exported From Confluence MIME-Version: 1.0 Content-Type: multipart/related; boundary="----=_Part_3892_1179356797.1711701287676" ------=_Part_3892_1179356797.1711701287676 Content-Type: text/html; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Content-Location: file:///C:/exported.html
The Domainrobot API offers different possibilities of authentication. De= pending on the selected API, the following authentication options are avail= able:
JSON and XML:
XML only:
Authentication with the AutoDNS user name and your AutoDNS context. You = must define the password yourself.
User ($user) and password ($password) are specified as Basic Auth. The c= ontext is specified here via the header X-Domainrobot-Context.
Note the context numbers. Context "1" refers to the demo system, context= "4" or the PersonalAutoDNS context number, the live system.
Example Http-Header :
You have to pass the following http header for the username "user", the = password "password" and the context "4":
More information about Basic Auth can be found at = : https://en.wikipedia.org/wiki/Basic_access_authen= tication
For this type of authentication, the data of the Trusted App ($uuid:$pas= sword) must be specified as Basic Auth.
Authentication via a session is only recommended if an "automatic sessio= n timeout" is required for the API implementation. We always recommend to u= se Authentication via Credentials (username/password/context).
The session to be used for authentication must first be created with a <= a href=3D"https://help.internetx.com/x/sY9QAg">AuthSessionCreate reques= t.
After a successful login, the system returns the user data in the respon= se. Depending on the query parameters selected, additional user data is out= put. The SessionID is returned in the header.
Set-Cooki= e: domainrobot_session=3D$sessionID; Path=3D/;Max-Age=3D599;secure;httponly=
The SessionID returned at login is now available for further orders. It = can be used in the orders in the header (X-Domainrobot-SessionId) = or as a cookie.
X-Domainr= obot-SessionId: $sessionID
The current working session can be terminated via the GET /logout route.
Note the context numbers. Context "1" refers to the demo system, context= "4" or the PersonalAutoDNS context number, the live system.
Authentication with the AutoDNS user name and your AutoDNS context. You = must define the password yourself. It is entered in the auth block in the &= lt;password> tag.
<auth&= gt; =09<user>USER</user> =09<context>CONTEXT</context> =09<password>PASSWORD</password> </auth>
A "Trusted Application" is an application that you have created in AutoD= NS as trustworthy.
<reque= st> =09<authentication> =09=09<trusted_application> =09=09=09<uuid>USER</uuid> =09=09=09<password>PASSWORD</password> =09=09=09<application> =09=09=09=09<name>TRUSTED_APP_NAME</name> =09=09=09</application> =09=09</trusted_application> =09</authentication> =09<task> =09=09<!-- .... --> =09</task> </request>
Authentication via a session is only recommended if an "automatic sessio= n timeout" is required for the API implementation. We always recommend to u= se Authentication via Credentials (username/password/context).
You create the AutoDNS SessionID with an AuthSessionCreate request.
The AutoDNS SessionID is a UUID (Universally Unique Identifier) with whi= ch you authenticate yourself for the duration of a working session. The aut= h_session block replaces the auth block.
<reque= st> =09<auth_session> =09=09<hash>9b4b36ff-2bed-41c8-8471-6ede5d2873dd</hash> =09</auth_session> =09<task> =09=09<!-- .... --> =09</task> </request>
You end the working session with an AuthSessionDelete request= span>.
With the 2FA, a six-digit numerical code, the so-called token, must be e= ntered in addition to the user name and password.
The token is generated using the time-based One-time Password Algorithm = (RF= C 6238).
The token is entered in the auth block in the <token< tag.
<auth&= gt; =09<user>USER</user> =09<context>CONTEXT</context> =09<password>PASSWORD</password> =09<token>TOKEN</token> </auth>