RestSetBasicAuth
value RestSetBasicAuth ( value rest, string strUsername, string strPassword );
Rückgabewert
Rückgabewert |
Beschreibung |
TRUE / true / 1 |
Die Authentifizierungseinstellungen wurden erfolgreich gesetzt. |
FALSE / false / 0 |
Das Setzen der Authentifizierungseinstellungen ist fehlgeschlagen. Das REST-Objekt rest ist ungültig. |
Parameter
rest
Das gültige REST-Objekt, in dem die Authentifizierungseinstellungen angelegt werden sollen.
strUsername
Der Benutzername, der für die Standardauthentifizierung gültig ist.
strPassword
Das Kennwort, das für die Standardauthentifizierung gültig ist.
Bemerkungen
Legt den Benutzernamen strUsername und das Kennwort strPassword für die Standardauthentifizierung des gültigen REST-Objekts rest fest. Diese Methode sollte aufgerufen werden, wenn eine Standardauthentifizierung erforderlich ist. Es sollte nur mit sicheren SSL/TLS-Verbindungen verwendet werden. Wenn diese Methode aufgerufen wird, wird der Header "Authorization: Basic ..." automatisch allen Anforderungen hinzugefügt. In vielen Fällen unterstützt eine REST-API die Standardauthentifizierung, bei der der Benutzername eine Client-ID oder eine Konto-ID und das Kennwort ein Client-Kennwort oder Client-Token ist.
Beispiel
//postman-echo.com liefert als Antwort eine Auswertung der empfangenen REST-Anfrage value rest, StatusCode; string strLastError, strResponse; if (!RestConnect(rest, "https://postman-echo.com", 443, true)) RestGetLastError(rest, strLastError, true); return; end RestSetBasicAuth(rest, "postman", "password"); RestFullRequest(rest, "GET", "/basic-auth", NULL, strResponse); strResponse = JsonExpand(strResponse); //Inhalt von strResponse: //{ // "authenticated": true //}StatusCode = RestGetResponseStatusCode(rest); //StatusCode = 200 RestRemoveBasicAuth(rest); RestFullRequest(rest, "GET", "/basic-auth", NULL, strResponse); //Inhalt von strResponse: //Unauthorized StatusCode = RestGetResponseStatusCode(rest); //StatusCode = 401 RestSetBasicAuth(rest, "user", ""); RestFullRequest(rest, "GET", "/basic-auth", NULL, strResponse); //Inhalt von strResponse: //Unauthorized StatusCode = RestGetResponseStatusCode(rest); //StatusCode = 401 RestDisconnect(rest);
Siehe auch RestAddHeader, RestAddPathParam, RestAddQueryParam, RestAddQueryParams, RestSetIdleTimeout, RestRemoveAllHeaders, RestRemoveAllPathParams, RestRemoveAllQueryParams, RestRemoveBasicAuth