---
sourceDocument: Yokohama-API-Referenz
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/de-DE/yokohama/api-reference

 Release :

    - yokohama

ft:locale :

    - de-DE

ft:publication_title :

    - Yokohama-API-Referenz

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# Anmeldeinformationen -- Umfang

# Anmeldeinformationen -- Umfang {#ariaid-title1}

* Freigeben Version: Yokohama
* 
* Aktualisiert 30. Januar 2025
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 2 Minuten Lesedauer

Die Anmeldeinformationen () Die API bietet Methoden, mit denen Sie Anmeldeinformationen für eine REST-Anforderung erstellen können.  
Generieren Sie ausgehende Signaturanforderungen mithilfe dieser 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 AnforderungsAuthAPI Klasse.
3. AnforderungsAuthAPI : 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.
{#AuthCredentialAPI__ol_gvv_22t_tjb}

Bevor Sie diese APIs verwenden, müssen Sie dies tun [Konfigurieren Sie einen Authentifizierungsalgorithmus](https://www.servicenow.com/docs/access?context=configure-authentication-algorithm&version=yokohama&pubname=yokohama-platform-security&ft:locale=en-US)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 Standard-Anmeldeinformationsanbieter Klasse zum Instanziieren eines Authentifizierungs-Anmeldeinformationsobjekts mithilfe eines Anmeldeinformationsdatensatzes aus der Tabelle „Anmeldeinformationen" \[Discovery_credentials\]. Wenn Sie ein leeres Authentifizierungs-Objekt erstellen, verwenden Sie Attribut festlegen () Methode zum Hinzufügen von Eigenschaften zum Objekt. {#AuthCredentialAPI__p_mpf_pjx_zjb}  
Das folgende Beispiel zeigt, wie eine Anmeldeinformation mit instanziiert wird Standard-Anmeldeinformationsanbieter :

    // 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.

## Anmeldeinformationen: Anmeldeinformationen (Objekt-Authentifizierungs-Anmeldeinformationen) {#ariaid-title2}

Instanziiert ein neues Authentifizierungs-Objekt oder ändert ein vorhandenes.
Sie können ein leeres Authentifizierungs-Objekt erstellen, ein vorhandenes Authentifizierungs-Objekt instanziieren oder verwenden Standard-Anmeldeinformationsanbieter Klasse zum Instanziieren eines Authentifizierungs-Anmeldeinformationsobjekts mithilfe eines Anmeldeinformationsdatensatzes aus der Tabelle „Anmeldeinformationen" \[Discovery_credentials\]. Wenn Sie ein leeres Authentifizierungs-Objekt erstellen, verwenden Sie Attribut festlegen () Methode zum Hinzufügen von Eigenschaften zum Objekt.
{#AuthCredential-AuthCredential_O__table_sjv_2sx_5jb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| AuthentifizierenAnmeldeinformationen | Objekt | Optional. Schließen Sie diesen Parameter ein, um ein vorhandenes Authentifizierungsobjekt zu aktualisieren. |
[Tabelle : 1. Parameter]

{#AuthCredential-AuthCredential_O__table_sjv_2sx_5jb}

## AuthCredential -- getAttribute (Zeichenfolgenschlüssel) {#ariaid-title3}

Gibt den Wert eines Attributs für Anmeldeinformationen zurück.
{#AuthCredential-getAttribute_S__table_ss5_hsx_5jb__entry__3}

| 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 Attribut festlegen () 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 : 2. Parameter]

{#AuthCredential-getAttribute_S__table_ss5_hsx_5jb} {#AuthCredential-getAttribute_S__table_ts5_hsx_5jb__entry__2}

| Typ | Beschreibung |
|-|-|
| Ungültig |   |
[Tabelle : 3. Rückgaben]

{#AuthCredential-getAttribute_S__table_ts5_hsx_5jb}  

    // 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) {#ariaid-title4}

Legt ein Attribut für ein Authentifizierungs-Objekt fest.
{#AuthCredential-setAttribute_S_S__table_off_jsx_5jb__entry__3}

| 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 : 4. Parameter]

{#AuthCredential-setAttribute_S_S__table_off_jsx_5jb} {#AuthCredential-setAttribute_S_S__table_pff_jsx_5jb__entry__2}

| Typ | Beschreibung |
|-|-|
| Ungültig |   |
[Tabelle : 5. Rückgaben]

{#AuthCredential-setAttribute_S_S__table_pff_jsx_5jb}  

    // 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");


