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


---

# AnforderungsAuthAPI -- Umfang

# AnforderungsAuthAPI -- Umfang {#ariaid-title1}

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

Die AnforderungsAuthAPI Stellt Methoden zum Anwenden einer Signatur auf eine REST-Anforderung bereit.  
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.
{#RequestAuthAPI__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.

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

## RequestAuthAPI -- RequestAuthAPI (Objektdaten, Objektanmeldeinformationen) {#ariaid-title2}

Instanziiert ein Request AuthAPI-Objekt mithilfe einer REST-Anforderung und einer Anmeldeinformation.
{#RequestAuthAPI-RequestAuthAPI_O_O__table_htv_rvv_5jb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Daten | Objekt | HttpRequestData-Objekt, das die nicht signierte REST-Anforderung enthält. Verwenden Sie HttpRequestData Klasse zum Erstellen dieses Objekts. Siehe [HttpRequestData-API](https://servicenow-prod.fluidtopics.net/8ZcWx8z8VwCjzebnnKbJug#HttpRequestDataAPI "Die HttpRequestData Die API bietet Methoden zum Erstellen und Bearbeiten einer REST-Anforderung, bevor eine Signatur angewendet und an einen Endpunkt gesendet wird."). |
| Anmeldeinformationen | Objekt | Objekt, das einen Datensatz aus der Tabelle „Anmeldeinformationen" \[Discovery_credentials\] darstellt. Rufen Sie dieses Objekt mit ab Anmeldeinformationen Klasse. Siehe [API für Authentifizierungs-Anmeldeinformationen](https://servicenow-prod.fluidtopics.net/_V5_tHfM4Bf~Ed7iTMXKpQ#AuthCredentialAPI "Die Anmeldeinformationen () Die API bietet Methoden, mit denen Sie Anmeldeinformationen für eine REST-Anforderung erstellen können."). |
[Tabelle : 1. Parameter]

{#RequestAuthAPI-RequestAuthAPI_O_O__table_htv_rvv_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 a credential record
    var credential = new sn_cc.StandardCredentialsProvider().getAuthCredentialByID("88772d0d40990010f8772fdd9ebc8075");
     
    // Instantiate a RequestAuthAPI object
    var signingAPI = new sn_auth.RequestAuthAPI(httpRequestData, credential);

## RequestAuthAPI -- generateAuth() {#ariaid-title3}

Signiert das HttpRequestData-Objekt und gibt ein HttpRequestAuthedData-Objekt zurück, das zum Senden der REST-Anforderung verwendet werden soll.
{#RequestAuthAPI-generateAuth__table_uhw_sy4_5jb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Keine |   |   |
[Tabelle : 2. Parameter]

{#RequestAuthAPI-generateAuth__table_uhw_sy4_5jb} {#RequestAuthAPI-generateAuth__table_vhw_sy4_5jb__entry__2}

| Typ | Beschreibung |
|-|-|
| HttpRequestAuthedData | Objekt. Daten, die zum Abrufen von Informationen zum signierten Ergebnis verwendet werden sollen. Verwenden Sie die Methoden in HttpRequestAuthedData Klasse, die mit dem signierten Ergebnis interagiert. Siehe [HttpRequestAuthedData-API](https://servicenow-prod.fluidtopics.net/hFlKIE8h_t5tB64P6ef99w#HttpRequestAuthedDataAPI "Die HttpRequestAuthedData() Die API bietet Methoden zum Zugreifen auf und Festlegen von Werten in einer signierten REST- oder SOAP-Anforderung."). |
[Tabelle : 3. Rückgaben]

{#RequestAuthAPI-generateAuth__table_vhw_sy4_5jb}  
Dieses Beispiel erstellt eine Anforderung und ruft einen Anmeldeinformationsdatensatz ab, der an übergeben werden soll AnforderungsAuthAPI API. Die GenerateAuth() Methode signiert dann die Anforderung.

    // 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 a credential record
    gs.info( "date:" + httpRequestData.getDate() );
    var credential = new sn_cc.StandardCredentialsProvider().getAuthCredentialByID("5b61c16f73533300f662cff8faf6a74b");
     
    // Create the RequestAuthAPI object and sign the request
    var signingAPI = new sn_auth.RequestAuthAPI(httpRequestData, credential);
    var output = signingAPI.generateAuth();
     
## RequestAuthAPI -- getAuthCredential() {#ariaid-title4}

Gibt den Anmeldeinformationsdatensatz zurück, der zum Signieren der Anforderung verwendet wird.
{#RequestAuthAPI-getAuthCredential__table_pfm_ny4_5jb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Keine |   |   |
[Tabelle : 4. Parameter]

{#RequestAuthAPI-getAuthCredential__table_pfm_ny4_5jb} {#RequestAuthAPI-getAuthCredential__table_qfm_ny4_5jb__entry__2}

| Typ | Beschreibung |
|-|-|
| Anmeldeinformationen | Objekt. Daten, die zum Abrufen von Informationen zum Anmeldeinformationsdatensatz verwendet werden sollen, der zum Signieren der Anforderung verwendet wird. Verwenden Sie die Methoden in Anmeldeinformationen Klasse zur Interaktion mit den Anmeldeinformationen. Siehe [API für Authentifizierungs-Anmeldeinformationen](https://servicenow-prod.fluidtopics.net/_V5_tHfM4Bf~Ed7iTMXKpQ#AuthCredentialAPI "Die Anmeldeinformationen () Die API bietet Methoden, mit denen Sie Anmeldeinformationen für eine REST-Anforderung erstellen können."). |
[Tabelle : 5. Rückgaben]

{#RequestAuthAPI-getAuthCredential__table_qfm_ny4_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 a credential record
    var credential = new sn_cc.StandardCredentialsProvider().getAuthCredentialByID("5b61c16f73533300f662cff8faf6a74b");
     
    // Return the AuthCredential object
    var signingAPI = new sn_auth.RequestAuthAPI(httpRequestData, credential);
    var signingCredential = signingAPI.getAuthCredential();

## RequestAuthAPI -- getHttpRequestData() {#ariaid-title5}

Gibt das HttpRequestData-Objekt zurück, das zum Instanziieren von verwendet wurde AnforderungsAuthAPI Klasse.
{#RequestAuthAPI-getHttpRequestData__table_hp2_ly4_5jb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Keine |   |   |
[Tabelle : 6. Parameter]

{#RequestAuthAPI-getHttpRequestData__table_hp2_ly4_5jb} {#RequestAuthAPI-getHttpRequestData__table_ip2_ly4_5jb__entry__2}

| Typ | Beschreibung |
|-|-|
| HttpRequestData | Objekt. Enthält die nicht signierte REST-Anforderung. Verwenden Sie die Methoden in HttpRequestData Klasse, die mit der Anforderung interagiert werden soll. Siehe [HttpRequestData-API](https://servicenow-prod.fluidtopics.net/8ZcWx8z8VwCjzebnnKbJug#HttpRequestDataAPI "Die HttpRequestData Die API bietet Methoden zum Erstellen und Bearbeiten einer REST-Anforderung, bevor eine Signatur angewendet und an einen Endpunkt gesendet wird."). |
[Tabelle : 7. Rückgaben]

{#RequestAuthAPI-getHttpRequestData__table_ip2_ly4_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 a credential record
    var credential = new sn_cc.StandardCredentialsProvider().getAuthCredentialByID("88772d0d40990010f8772fdd9ebc8075");
     
    // Return the HttpRequestData object
    var signingAPI = new sn_auth.RequestAuthAPI(httpRequestData, credential);
    var unsignedRequest = signingAPI.getHttpRequestData();
     
    gs.info("Endpoint is: " + unsignedRequest.getEndpoint());

Ausgabe:

    Endpoint is: https://third-party-endpoint

## RequestAuthAPI -- resetAuthCredential() {#ariaid-title6}

Generiert ein temporäres Token mit eingeschränkten Berechtigungen, das Sie verwenden können, um vertrauenswürdigen Anwendern temporäre Sicherheitsanmeldeinformationen zur Steuerung von Drittparteiressourcen bereitzustellen.
Zur Verwendung dieser Methode muss der Drittpartei-Service eine API oder ein SDK enthalten, die Token mit eingeschränktem Zugriff verarbeitet und verwaltet.
{#RequestAuthAPI-resetAuthCredential__table_rxd_qy4_5jb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Keine |   |   |
[Tabelle : 8. Parameter]

{#RequestAuthAPI-resetAuthCredential__table_rxd_qy4_5jb} {#RequestAuthAPI-resetAuthCredential__table_sxd_qy4_5jb__entry__2}

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

{#RequestAuthAPI-resetAuthCredential__table_sxd_qy4_5jb}  

    // Creates a temporary token 
    function(authAPI) {​
        var requestData = authAPI.getHttpRequestData();​
        var credential= authAPI.getAuthCredential();​
        credential.setAttribute('Action', 'aws_sessionToken');​  
        authAPI.resetAuthCredential();	

        //Returns status information
        var status = credential.getAttribute('credential_reset_status'); ​
    }


