Suche in diesem Bereich

Skip to end of metadata
Go to start of metadata


Inhaltsverzeichnis dieser Seite

Einführung

Die Domainrobot-API bietet verschiedene Möglichkeiten der Authentifizierung. Abhängig von der gewählten API stehen ihnen folgende Authentifizierung-Möglichkeiten zur Verfügung:

JSON und XML:

  • Credentials (Benutzer/Kontext/Passwort)
  • SessionID
  • TrustedApp

Nur XML:

  • Zwei-Faktor-Authentifizierung
  • SingleSignOn-Authentifizierung

JSON-API

Authentifizierung über Credentials (Benutzername/Context/Passwort)

Authentifizierung mit dem AutoDNS Benutzernamen und Ihrem AutoDNS Kontext. Das Passwort müssen Sie selber festlegen.

Benutzer ($user) und Passwort ($password) werden als Basic Auth angegeben. Der Kontext wird hier über den Header X-Domainrobot-Context angegeben.

Beachten Sie die Kontextnummern. Kontext "1" bezeichnet das Demo-System, Kontext "4" bzw. die PersonalAutoDNS Kontextnummer, das Live-System.

Authentifizierung über Trusted Application

Für diese Art der Authentifizierung müssen die Daten der Trusted App ($uuid:$password) als Basic Auth angegeben werden.

Authentifizierung über die SessionID

Login

Die Session, die für die Authentifizierung genutzt werden soll, muss mit folgendem Auftrag zunächst angelegt werden.

JSON
POST /login?acl=true&profile=true&customer=true&timeout=60
{
	"user": "$user",
	"context": $context,
	"password": "$password"
}

Liste der Abfrageparameter

ParameterBeschreibungWerteBenötigt
aclGibt an, ob die ACL des Benutzers in der Antwort ausgegeben werden sollen.true/falseOPTIONAL
profileGibt an, ob die Profildaten in der Antwort ausgegeben werden sollen.true/falseOPTIONAL
customerGibt an, ob die Kundendaten in der Antwort ausgegeben werden sollen.true/falseOPTIONAL
timeoutGibt die Session-Laufzeit in Minuten an.Standardwert 10 MinutenOPTIONAL

Bei erfolgreichen Login gibt das System in der Antwort die Benutzerdaten zurück. Abhängig von den gewählten Abfrageparametern, werden zusätzliche Daten des Benutzers ausgegeben. Die SessionID wird im Header zurückgeliefert.

Set-Cookie: domainrobot_session=$sessionID; Path=/;Max-Age=599;secure;httponly

Beispielantwort

JSON
{
    "status": {
        "code": "S1321001",
        "text": "Der Token für die Arbeitssitzung wurde erfolgreich angelegt.",
        "type": "SUCCESS"
    },
    "stid": "20180915-app1",
    "object": {
        "type": "user",
        "value": "username, 4"
    },
    "data": [
        {
            "user": "username",
            "context": 4,
            "defaultEmail": "user.name@domain.com",
            "status": 2,
            "substatus": 0,
            "owner": {},
            "language": "en"
        }
    ]
}

SessionID als Cookie/Header

Die beim Login zurückgelieferte SessionID steht nun für weitere Aufträge zur Verfügung. Sie kann in den Aufträgen im Header (X-Domainrobot-SessionId) oder als Cookie verwendet werden.


X-Domainrobot-SessionId: $sessionID

Logout

Über die Route GET /logout kann die aktuelle Arbeitssitzung beendet werden.

XML-API

Authentifizierung über Credentials (Benutzername/Context/Passwort)

Beachten Sie die Kontextnummern. Kontext "1" bezeichnet das Demo-System, Kontext "4" bzw. die PersonalAutoDNS Kontextnummer, das Live-System.

Authentifizierung mit dem AutoDNS Benutzernamen und Ihrem AutoDNS Kontext. Das Passwort müssen Sie selber festlegen. Es wird im auth-Block im Tag <password> eingegeben.

<auth>
	<user>USER</user>
	<context>CONTEXT</context>
	<password>PASSWORD</password>
</auth>

Authentifizierung über Trusted Application

Eine "Trusted Application" ist eine Applikation, die Sie im AutoDNS als vertrauenswürdig  angelegt haben.

<request>
	<authentication>
		<trusted_application>
			<uuid>USER</uuid>
			<password>PASSWORD</password>
			<application>
				<name>TRUSTED_APP_NAME</name>
			</application>
		</trusted_application>
	</authentication>
	<task>
		<!-- .... -->
	</task>
</request>

Authentifizierung über die SessionID

Login

Sie erzeugen die AutoDNS SessionID mit dem XML -Auftragstyp AuthSession Create - 1321001.

SessionID als XML-Tag

Die AutoDNS SessionID ist eine UUID (Universally Unique Identifier) mit der Sie sich für die Dauer einer Arbeitssitzung authentifizieren. Sie  wird im auth_session-Block im Tag <hash> eingegeben.

XML
<request>
	<auth_session>
		<hash>9b4b36ff-2bed-41c8-8471-6ede5d2873dd</hash>
	</auth_session>
	<task>
		<!-- .... -->
	</task>
</request>

Logout

Sie beenden die Arbeitssitzung mit dem XML-Auftragstyp AuthSession Delete - 1321003.

Authentifizierung über Zwei-Faktor-Authentifizierung (2FA)

Bei der Zwei-Faktor-Authentifizierung muß zusätzlich zu Benutzernamen und Passwort ein sechsstelliger Zahlencode, der sogenannte Token, eingegeben werden.

Token erzeugen

Der Token wird mit dem Time-based One-time Password Algorithmus (RFC 6238) erzeugt.

Token verwenden

Der Token wird im auth-Block im Tag <token> eingegeben.

<auth>
	<user>USER</user>
	<context>CONTEXT</context>
	<password>PASSWORD</password>
	<token>TOKEN</token>
</auth>