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


---

# HttpRequestAuthedData -- Umfang

# HttpRequestAuthedData -- Umfang {#ariaid-title1}

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

Die HttpRequestAuthedData() Die API bietet Methoden zum Zugreifen auf und Festlegen von Werten in einer signierten REST- oder SOAP-Anforderung.  
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.
{#HttpRequestAuthedDataAPI__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. Sie können diese Klasse mit dem Konstruktor instanziieren oder ein HttpRequestAuthedData-Objekt von zurückgeben GenerateAuth() Methode in AnforderungsAuthAPI Klasse.

## HttpRequestAuthedData -- HttpRequestAuthedData() {#ariaid-title2}

Instanziiert ein HttpRequestAuthedData-Objekt.
Sie können diese Klasse mit dem Konstruktor instanziieren oder ein HttpRequestAuthedData-Objekt von zurückgeben GenerateAuth() Methode in AnforderungsAuthAPI Klasse.
{#HRAD-HttpRequestAuthedData__table_ug1_xxy_vjb__entry__3}

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

{#HRAD-HttpRequestAuthedData__table_ug1_xxy_vjb}

## HttpRequestAuthedData -- addHeader(Zeichenfolgenschlüssel, Zeichenfolgenwert) {#ariaid-title3}

Fügt dem Objekt „HttpRequestAuthedData" einen Header hinzu.
{#HRAD-addHeader_S_S__table_fv4_zxy_vjb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| key | Zeichenfolge | Name des HTTP-Headers. |
| Wert | Zeichenfolge | Wert des HTTP-Headers. |
[Tabelle : 2. Parameter]

{#HRAD-addHeader_S_S__table_fv4_zxy_vjb} {#HRAD-addHeader_S_S__table_gv4_zxy_vjb__entry__2}

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

{#HRAD-addHeader_S_S__table_gv4_zxy_vjb}  

    // Define HttpRequestData
    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);
     
    //Get AuthCredential
    var credential = new sn_cc.StandardCredentialsProvider().getAuthCredentialByID("5b61c16f73533300f662cff8faf6a74b");
     
    // Create RequestAuthAPI and sign the request
    var signingAPI = new sn_auth.RequestAuthAPI(httpRequestData, credential);
    var output = signingAPI.generateAuth();
     
    // Update the signed response
    output.addHeader('access-rights', 'public-read');

## HttpRequestAuthedData -- addQueryParam(Zeichenfolgenschlüssel, Zeichenfolgenwert) {#ariaid-title4}

Fügt dem Objekt „HttpRequestAuthedData" einen Abfrageparameter hinzu.
{#HRAD-addQueryParam_S_S__table_fv4_zxy_vjb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| key | Zeichenfolge | Name des Abfrageparameters. |
| Wert | Zeichenfolge | Wert des Abfrageparameters. |
[Tabelle : 4. Parameter]

{#HRAD-addQueryParam_S_S__table_fv4_zxy_vjb} {#HRAD-addQueryParam_S_S__table_bpw_byy_vjb__entry__2}

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

{#HRAD-addQueryParam_S_S__table_bpw_byy_vjb}  

    // Define HttpRequestData
    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);
     
    //Get AuthCredential
    var credential = new sn_cc.StandardCredentialsProvider().getAuthCredentialByID("5b61c16f73533300f662cff8faf6a74b");
     
    // Create RequestAuthAPI and sign the request
    var signingAPI = new sn_auth.RequestAuthAPI(httpRequestData, credential);
    var output = signingAPI.generateAuth();
     
    // Update the signed response
    output.addQueryParameter('api_version', 'v2');

## HttpRequestAuthedData -- getCredentialValue() {#ariaid-title5}

Gibt den Anmeldeinformationswert zurück, der beim Signieren der Anforderung enthalten war.
Verwenden Sie einen Anmeldeinformationswert, um ein Cookie, eine Signatur oder einen anderen Wert zu speichern, der für einen Authentifizierungsalgorithmus erforderlich ist. Erstellen Sie beispielsweise einen Schritt „Verbindungsinformationen abrufen" (GCI) mit einem Skript, das ein einmaliges Token für einen REST- oder SOAP-Aufruf abruft und speichert.
{#HRAD-getCredentialValue__table_b5h_b1v_cqb__entry__3}

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

{#HRAD-getCredentialValue__table_b5h_b1v_cqb} {#HRAD-getCredentialValue__table_c5h_b1v_cqb__entry__2}

| Typ | Beschreibung |
|-|-|
| Zeichenfolge | Text des Anmeldeinformationswerts. |
[Tabelle : 7. Rückgaben]

{#HRAD-getCredentialValue__table_c5h_b1v_cqb}  
Dieses Beispiel zeigt den Abruf eines Anmeldeinformationswerts.

    var RequestAuthGCISigner = Class.create();
    RequestAuthGCISigner.prototype = Object.extend(new RequestAuthInternal(), {
      initialize: function() {
        RequestAuthInternal.prototype.initialize.call(this);
      },

      generateAuth: function(authAPI) {
        var requestData = authAPI.getHttpRequestData();

        // get credentials
        var credential = authAPI.getAuthCredential();
        var username = credential.getAttribute("user_name");
        var password = credential.getAttribute("password");
        var httpRequestSignedData = new sn_auth.HttpRequestAuthedData();
        var directive = requestData.getDirective();

        // set CREDENTIAL_VALUE
        httpRequestSignedData.setCredentialValue(username+":"+password);
        httpRequestSignedData.setDirective("CREDENTIAL_VALUE");
        httpRequestSignedData.setStatus("SUCCESS");

        gs.info("The Credential Value is " + httpRequestSignedData.getCredentialValue());
        return httpRequestSignedData;
      },
      type: 'RequestAuthGCISigner'
    });

Ausgabe:

    The Credential Value is someUsername:somePassword

## HttpRequestAuthedData -- getDirective() {#ariaid-title6}

Gibt zurück, ob die Signatur auf die Anforderung im Header, als Abfrageparameter oder als Anmeldeinformationswert angewendet wird.
Standardmäßig wendet das System die Signatur auf den Header an. Sie können die Signatur als Abfrageparameter oder Anmeldeinformationswert anwenden, indem Sie verwenden SetDirective() API.
{#HRAD-getDirective__table_kmr_dyy_vjb__entry__3}

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

{#HRAD-getDirective__table_kmr_dyy_vjb} {#HRAD-getDirective__table_lmr_dyy_vjb__entry__2}

| Typ | Beschreibung |
|-|-|
| Zeichenfolge | Gibt an, ob die Signatur auf den Header, als Abfrageparameter oder als Anmeldeinformationswert angewendet wird. Werte: * HEADER: Die Signatur wird auf den Anforderungsheader angewendet. * ABFRAGE: Die Signatur wird als Abfrageparameter angewendet. * CREDENTIAL_VALUE: Die Signatur wird als Anmeldeinformationswert angewendet. {#HRAD-getDirective__ul_xdw_v5b_5jb} |
[Tabelle : 9. Rückgaben]

{#HRAD-getDirective__table_lmr_dyy_vjb}  

    // Define HttpRequestData
    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);
     
    //Get AuthCredential
    var credential = new sn_cc.StandardCredentialsProvider().getAuthCredentialByID("5b61c16f73533300f662cff8faf6a74b");
     
    // Create RequestAuthAPI and sign the request
    var signingAPI = new sn_auth.RequestAuthAPI(httpRequestData, credential);
    var output = signingAPI.generateAuth();
    output.setDirective("header");

    gs.info("Signature applied to: " + output.getDirective());

Ausgabe:

    Signature applied to: HEADER

## HttpRequestAuthedData -- getHeaderMap() {#ariaid-title7}

Gibt ein Objekt zurück, das die Header enthält, die beim Signieren der Anforderung enthalten waren.
{#HRAD-getHeaderMap__table_w3n_fyy_vjb__entry__3}

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

{#HRAD-getHeaderMap__table_w3n_fyy_vjb} {#HRAD-getHeaderMap__table_x3n_fyy_vjb__entry__2}

| Typ | Beschreibung |
|-|-|
| Objekt | Schlüssel-Wert-Paare, die alle Header definieren, die beim Signieren der Anforderung enthalten sind. Jedes Schlüssel-Wert-Paar enthält diese Teile: * Schlüssel: Zeichenfolge. Name des Headers. * Wert: Zeichenfolge. Wert des Headers. {#HRAD-getHeaderMap__ul_adn_4qh_5jb} |
[Tabelle : 11. Rückgaben]

{#HRAD-getHeaderMap__table_x3n_fyy_vjb}  

    // 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 an AuthCredential object
    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();
     
    // get the signed response detail
    var authH = headerM["Authorization"];
    var xamzdateH = headerM["X-Amz-Date"];
    var content256 = headerM["x-amz-content-sha256"];
     
    gs.debug('authH:' + authH );
    gs.debug('xamzdateH:' + xamzdateH );
    gs.debug('content256:' + content256 );

Ausgabe:

    *** Script: [DEBUG] authH:AWS4-HMAC-SHA256 Credential=lsjfljljfllfwek/20191127/us-east-1/s3/aws4_request, 
    SignedHeaders=host;x-amz-acl;x-amz-content-sha256;x-amz-date, 
    Signature=5c349011324910c34596ba7abbd10e07c4127774049f8953418bd7bed7d02b90 
    *** Script: [DEBUG] xamzdateH:20191127T175210Z 
    *** Script: [DEBUG] content256:UNSIGNED-PAYLOAD

## HttpRequestAuthedData -- getQueryMap() {#ariaid-title8}

Gibt ein Objekt zurück, das die Abfrageparameter enthält, die beim Signieren der Anforderung enthalten sind.
{#HRAD-getQueryMap__table_ejx_gyy_vjb__entry__3}

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

{#HRAD-getQueryMap__table_ejx_gyy_vjb} {#HRAD-getQueryMap__table_fjx_gyy_vjb__entry__2}

| Typ | Beschreibung |
|-|-|
| Objekt | Schlüssel-Wert-Paare, die die Abfrageparameter definieren, die beim Signieren der Anforderung enthalten sind. Jedes Schlüssel-Wert-Paar enthält diese Teile: * Schlüssel: Zeichenfolge. Name des Abfrageparameters. * Wert: Zeichenfolge. Wert des Abfrageparameters. {#HRAD-getQueryMap__ul_adn_4qh_5jb} |
[Tabelle : 13. Rückgaben]

{#HRAD-getQueryMap__table_fjx_gyy_vjb}  

    // 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.addQueryParam('api_version', 'v2' );
    httpRequestData.addQueryParam('limit', '1000' );
    httpRequestData.addQueryParam('offset', '1' );
     
    // Get an AuthCredential object
    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();
     
    // Get the signed response
    queryMap = output.getQueryMap();

    gs.info("API Version is: " + queryMap["api_version"]);

Ausgabe:

    API Version is: v2

## HttpRequestAuthedData -- getStatus() {#ariaid-title9}

Gibt den Status der Anforderungssignatur zurück.
{#HRAD-getStatus__table_pwx_3yy_vjb__entry__3}

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

{#HRAD-getStatus__table_pwx_3yy_vjb} {#HRAD-getStatus__table_qwx_3yy_vjb__entry__2}

| Typ | Beschreibung |
|-|-|
| Zeichenfolge | Der Status der Anforderungssignatur. Mögliche Werte: * ERFOLG: Das System hat die Anforderung erfolgreich signiert. * FEHLER: Das System konnte die Anforderung nicht signieren. * ÜBERSPRUNGEN: Das System hat die Signatur übersprungen, da die Informationen unvollständig waren. {#HRAD-getStatus__ul_kfj_1f1_wjb} |
[Tabelle : 15. Rückgaben]

{#HRAD-getStatus__table_qwx_3yy_vjb}  

    // 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);
     
    // Get an AuthCredential object
    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();
     
    // Get the signed status
    gs.info("Status is: " + output.getStatus());

Ausgabe:

    Status is: SUCCESS

## HttpRequestAuthedData -- getStatusMessage() {#ariaid-title10}

Gibt eine detaillierte Nachricht zur Anforderungssignierung zurück. Wenn die Anforderungssignatur fehlschlägt, gibt diese Methode die Fehlermeldung zurück.
{#HRAD-getStatusMessage__table_obq_kyy_vjb__entry__3}

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

{#HRAD-getStatusMessage__table_obq_kyy_vjb} {#HRAD-getStatusMessage__table_pbq_kyy_vjb__entry__2}

| Typ | Beschreibung |
|-|-|
| Zeichenfolge | Nachricht über die Anforderungssignatur. Wenn die Anforderungssignatur fehlschlägt, wird eine der folgenden Fehlermeldungen zurückgegeben: * Anmeldeinformationen sind ungültig : Überprüfen Sie das Authentifizierungsobjekt, das Sie zum Signieren der Anforderung verwendet haben. Stellen Sie sicher, dass den Anmeldeinformationen ein Authentifizierungsalgorithmus zugeordnet ist. Weitere Informationen finden Sie unter [Konfigurieren Sie einen Authentifizierungsalgorithmus](https://www.servicenow.com/docs/access?context=configure-authentication-algorithm&version=yokohama&pubname=yokohama-platform-security&ft:locale=en-US). * Anforderungsdaten sind leer. Anforderungsauthentifizierung wird übersprungen : Überprüfen Sie das Objekt „HttpRequestData", da erforderliche Informationen möglicherweise fehlen. * Skripteinbindungsbereich kann nicht gefunden werden : Stellen Sie sicher, dass der Authentifizierungsalgorithmus-Datensatz und die zugehörigen Skripteinbindungen, die zum Signieren der Anforderung verwendet werden, im richtigen Umfang liegen. {#HRAD-getStatusMessage__ul_vj2_ll1_wjb} |
[Tabelle : 17. Rückgaben]

{#HRAD-getStatusMessage__table_pbq_kyy_vjb}  

    // 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.addQueryParam('api_version', 'v2' );
    httpRequestData.addQueryParam('limit', '1000' );
    httpRequestData.addQueryParam('offset', '1' );
     
    // Get AuthCredential object and set an attribute
    var credential = new sn_auth.AuthCredential();
    credential.setAttribute("user_name", "admin");
    credential.setAttribute("password", "admin");
     
    // Create the RequestAuthAPI object and sign the request
    var signingAPI = new sn_auth.RequestAuthAPI(httpRequestData, credential);
    var output = signingAPI.generateAuth();
     
    // Get the signed status
    gs.info("Status message is: " + output.getStatusMessage());

Ausgabe:

    Status message is: credential is not valid.

## HttpRequestAuthedData -- setCredentialValue(Zeichenfolge credential_value) {#ariaid-title11}

Legt einen Anmeldeinformationswert für das Objekt „HttpRequestAuthedData" fest.

Verwenden Sie einen Anmeldeinformationswert, um ein Cookie, eine Signatur oder einen anderen Wert zu speichern, der für einen Authentifizierungsalgorithmus erforderlich ist. Erstellen Sie beispielsweise einen Schritt „Verbindungsinformationen abrufen" (GCI) mit einem Skript, das ein einmaliges Token für einen REST- oder SOAP-Aufruf abruft und speichert.

Verwenden Sie SetCredentialValue() Methode zum Festlegen von Anmeldeinformationswert Datenpille für REST-, SOAP- und GCI-Schritte in Workflow-Studio.
{#HRAD_setCredentialValue_S__table_srb_d1v_cqb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Credential_value | Zeichenfolge | Text des Anmeldeinformationswerts. |
[Tabelle : 18. Parameter]

{#HRAD_setCredentialValue_S__table_srb_d1v_cqb} {#HRAD_setCredentialValue_S__table_trb_d1v_cqb__entry__2}

| Typ | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 19. Rückgaben]

{#HRAD_setCredentialValue_S__table_trb_d1v_cqb}  
Dieses Beispiel zeigt, wie ein Anmeldeinformationswert für einen GCI-Schritt festgelegt wird.

    var RequestAuthGCISigner = Class.create();
    RequestAuthGCISigner.prototype = Object.extend(new RequestAuthInternal(), {
      initialize: function() {
        RequestAuthInternal.prototype.initialize.call(this);
      },

      generateAuth: function(authAPI) {
        var requestData = authAPI.getHttpRequestData();

        // get credentials
        var credential = authAPI.getAuthCredential();
        var username = credential.getAttribute("user_name");
        var password = credential.getAttribute("password");
        var httpRequestSignedData = new sn_auth.HttpRequestAuthedData();
        var directive = requestData.getDirective();
        var b64data = GlideStringUtil.base64encode(username+":"+password);

        // set CREDENTIAL_VALUE
        httpRequestSignedData.setCredentialValue("Basic " + b64data);
        httpRequestSignedData.setDirective("CREDENTIAL_VALUE");
        httpRequestSignedData.setStatus("SUCCESS");
        return httpRequestSignedData;
      },
      type: 'RequestAuthGCISigner'
    });

## HttpRequestAuthedData -- setDirective (Zeichenfolgenanweisung) {#ariaid-title12}

Definiert, ob die Signatur auf die signierte Anforderung im Header, als Abfrageparameter oder als Anmeldeinformationswert angewendet werden soll.
{#HRAD-setDirective_S__table_nxn_rcy_sjb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Richtlinie | Zeichenfolge | Gibt an, ob die Signatur auf den Header, den Abfrageparameter oder den Anmeldeinformationswert der signierten Anforderung angewendet werden soll. Werte: * `Abfrage `: Wendet Signatur als Abfrageparameter an. * `Header `: Wendet Signatur auf den Anforderungsheader an. * `Credential_value ` : Wendet Signatur auf den Anmeldeinformationswert an. {#HRAD-setDirective_S__ul_w2m_lzb_5jb} |
[Tabelle : 20. Parameter]

{#HRAD-setDirective_S__table_nxn_rcy_sjb} {#HRAD-setDirective_S__table_o3n_myy_vjb__entry__2}

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

{#HRAD-setDirective_S__table_o3n_myy_vjb}  

    // Define HttpRequestData
    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);
     
    //Get AuthCredential
    var credential = new sn_cc.StandardCredentialsProvider().getAuthCredentialByID("5b61c16f73533300f662cff8faf6a74b");
     
    // Create RequestAuthAPI and sign the request
    var signingAPI = new sn_auth.RequestAuthAPI(httpRequestData, credential);
    var output = signingAPI.generateAuth();
    output.setDirective("header");

## HttpRequestAuthedData -- setStatus (Zeichenfolgenstatus) {#ariaid-title13}

Legt den Status der Anforderungssignatur fest.
{#HRAD-setStatus_S__table_pbr_4yy_vjb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Status | Zeichenfolge | Der Status der Anforderungssignatur. Mögliche Werte: * `Erfolg `: Das System hat die Anforderung erfolgreich signiert. * `Fehlgeschlagen `: Das System konnte die Anforderung nicht signieren. * `Übersprungen `: Das System hat die Signatur übersprungen, da die Informationen unvollständig waren. {#HRAD-setStatus_S__ul_nbg_jr1_wjb} |
[Tabelle : 22. Parameter]

{#HRAD-setStatus_S__table_pbr_4yy_vjb} {#HRAD-setStatus_S__table_qbr_4yy_vjb__entry__2}

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

{#HRAD-setStatus_S__table_qbr_4yy_vjb}  

    // 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);
     
    // Get an AuthCredential object
    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();
    output.setStatus("fail");
     
    // Get the signed status
    gs.info("Status is: " + output.getStatus());

Ausgabe:

     Status is: FAIL

## HttpRequestAuthedData -- setStatusMessage(String statusMessage) {#ariaid-title14}

Legt eine Statusnachricht für die Anforderungssignierung fest.
{#HRAD-setStatusMessage_S__table_vt4_qyy_vjb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| statusMessage | Zeichenfolge | Nachricht, die für den Signaturstatus der Anforderung festgelegt werden soll. |
[Tabelle : 24. Parameter]

{#HRAD-setStatusMessage_S__table_vt4_qyy_vjb} {#HRAD-setStatusMessage_S__table_wt4_qyy_vjb__entry__2}

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

{#HRAD-setStatusMessage_S__table_wt4_qyy_vjb}  

    // 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);
     
    // Get an AuthCredential object
    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();
    output.setStatusMessage("The request was successfully signed.");
     
    // Get the signed status message
    gs.info("Status message is: " + output.getStatusMessage());

Ausgabe:

    Status message is: The request was successfully signed.


