Anmeldeinformationen – Umfang

Die Authentifizierungs-Anmeldeinformationen () Die API bietet Methoden, mit denen Sie Anmeldeinformationen für eine REST-Anforderung erstellen können.

Generieren Sie ausgehende Signaturanforderungen mit diesen APIs in der folgenden Reihenfolge:

1. HttpRequestData : API-Anforderung erstellen.
2. Anmeldeinformationen : Erstellen Sie ein Anmeldeinformationsobjekt, oder aktualisieren Sie ein vorhandenes. Verwenden Sie die Anmeldeinformationen, um die Anforderung über zu signieren RequestAuthAPI Klasse.
3. RequestAuthAPI : Signieren Sie die Anforderung, und geben Sie ein HttpRequestAuthedData-Objekt zurück.
4. HttpRequestAuthedData : Ruft Informationen zur signierten Anforderung ab.
5. GlideHTTPRequest : Signierte Anforderung senden.

Bevor Sie diese APIs verwenden, müssen Sie dies tun Konfigurieren Sie einen Authentifizierungsalgorithmus Um die Anforderung zu signieren und den Anmeldeinformationen zuzuordnen, die zur Authentifizierung der Anforderung verwendet werden.

Sie können ein leeres Authentifizierungs-Objekt erstellen, ein vorhandenes Authentifizierungs-Objekt instanziieren oder verwenden StandardCredentialsProvider Klasse zum Instanziieren eines Authentifizierungsobjekts mithilfe eines Anmeldeinformationsdatensatzes aus der Tabelle „Anmeldeinformationen“ [Discovery_credentials]. Wenn Sie ein leeres AuthCredential-Objekt erstellen, verwenden Sie SetAttribute() Methode zum Hinzufügen von Eigenschaften zum Objekt.

Das folgende Beispiel zeigt, wie Sie eine Authentifizierungsanmeldeinformation mit instanziieren StandardCredentialsProvider :

// Return an AuthCredential object using a Credential sys_id
var credential = new sn_cc.StandardCredentialsProvider().getAuthCredentialByID("5b61c16f73533300f662cff8faf6a74b");

Verwenden Sie Anmeldeinformationen API in bereichsbezogenen Skripts mit sn_auth Namespace-Bezeichner.

AuthCredential: AuthCredential(Object AuthCredential)

Instanziiert ein neues AuthCredential-Objekt oder ändert ein vorhandenes.

Sie können ein leeres Authentifizierungs-Objekt erstellen, ein vorhandenes Authentifizierungs-Objekt instanziieren oder verwenden StandardCredentialsProvider Klasse zum Instanziieren eines Authentifizierungsobjekts mithilfe eines Anmeldeinformationsdatensatzes aus der Tabelle „Anmeldeinformationen“ [Discovery_credentials]. Wenn Sie ein leeres AuthCredential-Objekt erstellen, verwenden Sie SetAttribute() Methode zum Hinzufügen von Eigenschaften zum Objekt.

Tabelle : 1. Parameter

Name	Typ	Beschreibung
AuthCredential	Objekt	Optional. Schließen Sie diesen Parameter ein, um ein vorhandenes Authentifizierungsobjekt zu aktualisieren.

AuthCredential – getAttribute(Zeichenfolgenschlüssel)

Gibt den Wert eines Attributs „AuthCredential“ zurück.

Tabelle : 2. Parameter

Name	Typ	Beschreibung
key	Zeichenfolge	Schlüssel des Attributs, für das der Wert zurückgegeben werden soll. Wenn Sie eine leere erstellt haben Anmeldeinformationen Objekt, müssen Sie verwenden SetAttribute() Methode zum Hinzufügen von Eigenschaften zum Objekt. Wenn Sie einen Anmeldeinformationsdatensatz zum Instanziieren von verwendet haben Anmeldeinformationen Objekt, übergeben Sie einen Feldnamen aus der Tabelle „Anmeldeinformationen“ [Discovery_credentials], um auf den Wert zuzugreifen.

Tabelle : 3. Rückgaben

Typ	Beschreibung
void

// Define the HttpRequestData object
var endpoint= "https://third-party-endpoint";
var httpRequestData = new sn_auth.HttpRequestData();
httpRequestData.setEndpoint(endpoint);
httpRequestData.setService('s3');
httpRequestData.setRegion('us-east-1');
httpRequestData.setHttpMethod("PUT");
var content = "Action=SendMessage&MessageBody=This is a test message";
httpRequestData.setContent(content);
httpRequestData.addHeader('x-amz-acl', 'public-read' );
 
// Get AuthCredential object and set an attribute
var credential = new sn_auth.AuthCredential();
credential.setAttribute("user_name", "admin");
 
// Sign the request and return an AuthCredential attribute value
var signingAPI = new sn_auth.RequestAuthAPI(httpRequestData, credential);
var signingCredential = signingAPI.getAuthCredential();
name = signingCredential.getAttribute("name");

AuthCredential – setAttribute (Zeichenfolgenschlüssel, Zeichenfolgenwert)

Legt ein Attribut für ein Authentifizierungsobjekt fest.

Tabelle : 4. Parameter

Name	Typ	Beschreibung
key	Zeichenfolge	Name des festzulegenden Attributs. Wenn Sie eine leere erstellt haben Anmeldeinformationen Objekt, müssen Sie diese Methode verwenden, um dem Objekt Eigenschaften hinzuzufügen. Wenn Sie einen Anmeldeinformationsdatensatz zum Instanziieren von verwendet haben Anmeldeinformationen Objekt, übergeben Sie einen Feldnamen aus der Tabelle „Anmeldeinformationen“ [Discovery_credentials], um den Wert festzulegen.
Wert	Zeichenfolge	Wert des Attributs.

Tabelle : 5. Rückgaben

Typ	Beschreibung
void

// Define the HttpRequestData object
var endpoint= "https://third-party-endpoint";
var httpRequestData = new sn_auth.HttpRequestData();
httpRequestData.setEndpoint(endpoint);
httpRequestData.setService('s3');
httpRequestData.setRegion('us-east-1');
httpRequestData.setHttpMethod("PUT");
var content = "Action=SendMessage&MessageBody=This is a test message";
httpRequestData.setContent(content);
httpRequestData.addHeader('x-amz-acl' , 'public-read' );
 
// Get AuthCredential object and set an attribute
var credential = new sn_auth.AuthCredential();
credential.setAttribute("user_name", "admin");