---
sourceDocument: Référence de l’API Xanadu
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/fr-FR/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - fr-FR

ft:publication_title :

    - Référence de l’API Xanadu

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# HttpRequestAuthedData : inclus dans le champ d'application

# HttpRequestAuthedData : inclus dans le champ d'application {#ariaid-title1}

* Rversion finale: Xanadu
* 
* Mis à jour 1 août 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 9 minutes de lecture

L'API HttpRequestAuthedData() fournit des méthodes permettant d'accéder et de définir les valeurs d'une demande REST ou SOAP signée.  
Générez des demandes de signature sortantes à l'aide de ces API dans l'ordre suivant :

1. HttpRequestData : générer la demande d'API.
2. AuthCredential : créer un objet d'informations d'identification ou mettre à jour un objet existant. Utilisez les informations d'identification pour signer la demande via la classe RequestAuthAPI .
3. RequestAuthAPI : signer la demande et renvoyer un objet HttpRequestAuthedData.
4. HttpRequestAuthedData : obtenir des informations sur la demande signée.
5. GlideHTTPRequest : envoyer la demande signée.
{#HttpRequestAuthedDataAPI__ol_gvv_22t_tjb}

Avant d'utiliser ces API, vous devez [configurer un algorithme d'authentification](https://www.servicenow.com/docs/access?context=configure-authentication-algorithm&version=xanadu&pubname=xanadu-platform-security&ft:locale=en-US) pour signer la demande et l'associer aux informations d'identification utilisées pour authentifier la demande.

Utilisez cette API dans les scripts inclus dans le champ d'application avec l'identificateur `d'espace` de noms sn_auth. Vous pouvez instancier cette classe à l'aide du constructeur, ou vous pouvez renvoyer un objet HttpRequestAuthedData à partir de la méthode generateAuth() dans la classe RequestAuthAPI .

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

Instancie un objet HttpRequestAuthedData.
Vous pouvez instancier cette classe à l'aide du constructeur, ou vous pouvez renvoyer un objet HttpRequestAuthedData à partir de la méthode generateAuth() dans la classe RequestAuthAPI .
{#HRAD-HttpRequestAuthedData__table_ug1_xxy_vjb__entry__3}

| Nom | Type | Description |
|-|-|-|
| Aucun |   |   |
[Tableau 1. Paramètres]

{#HRAD-HttpRequestAuthedData__table_ug1_xxy_vjb}

## HttpRequestAuthedData : addHeader(clé de chaîne, valeur de chaîne) {#ariaid-title3}

Ajoute un en-tête à l'objet HttpRequestAuthedData.
{#HRAD-addHeader_S_S__table_fv4_zxy_vjb__entry__3}

| Nom | Type | Description |
|-|-|-|
| key | Chaîne | Nom de l'en-tête HTTP. |
| valide | Chaîne | Valeur de l'en-tête HTTP. |
[Tableau 2. Paramètres]

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

| Type | Description |
|-|-|
| nul |   |
[Tableau 3. Renvoie]

{#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(clé de chaîne, valeur de chaîne) {#ariaid-title4}

Ajoute un paramètre de requête à l'objet HttpRequestAuthedData.
{#HRAD-addQueryParam_S_S__table_fv4_zxy_vjb__entry__3}

| Nom | Type | Description |
|-|-|-|
| key | Chaîne | Nom du paramètre de requête. |
| valide | Chaîne | Valeur du paramètre de requête. |
[Tableau 4. Paramètres]

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

| Type | Description |
|-|-|
| nul |   |
[Tableau 5. Renvoie]

{#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}

Renvoie la valeur d'informations d'identification incluse lors de la signature de la demande.
Utilisez une valeur d'informations d'identification pour stocker un cookie, une signature ou toute autre valeur nécessaire pour un algorithme d'authentification. Par exemple, créez une étape Obtenir des informations de connexion (GCI) avec un script qui récupère et stocke un jeton à usage unique pour un appel REST ou SOAP.
{#HRAD-getCredentialValue__table_b5h_b1v_cqb__entry__3}

| Nom | Type | Description |
|-|-|-|
| Aucun |   |   |
[Tableau 6. Paramètres]

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

| Type | Description |
|-|-|
| Chaîne | Texte de la valeur d'informations d'identification. |
[Tableau 7. Renvoie]

{#HRAD-getCredentialValue__table_c5h_b1v_cqb}  
Cet exemple montre la récupération d'une valeur d'informations d'identification.

    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'
    });

Sortie :

    The Credential Value is someUsername:somePassword

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

Indique si la signature est appliquée à la demande dans l'en-tête, en tant que paramètre de requête ou en tant que valeur d'informations d'identification.
Par défaut, le système applique la signature à l'en-tête. Vous pouvez appliquer la signature en tant que paramètre de requête ou valeur d'informations d'identification à l'aide de l'API setDirective().
{#HRAD-getDirective__table_kmr_dyy_vjb__entry__3}

| Nom | Type | Description |
|-|-|-|
| Aucun |   |   |
[Tableau 8. Paramètres]

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

| Type | Description |
|-|-|
| Chaîne | Indique si la signature est appliquée à l'en-tête, en tant que paramètre de requête ou en tant que valeur d'informations d'identification. Les valeurs comprennent : * EN-TÊTE : La signature est appliquée à l'en-tête de la demande. * QUERY : La signature est appliquée en tant que paramètre de requête. * CREDENTIAL_VALUE : la signature est appliquée comme valeur d'informations d'identification. {#HRAD-getDirective__ul_xdw_v5b_5jb} |
[Tableau 9. Renvoie]

{#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());

Sortie :

    Signature applied to: HEADER

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

Renvoie un objet contenant les en-têtes inclus lors de la signature de la demande.
{#HRAD-getHeaderMap__table_w3n_fyy_vjb__entry__3}

| Nom | Type | Description |
|-|-|-|
| Aucun |   |   |
[Tableau 10. Paramètres]

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

| Type | Description |
|-|-|
| Objet | Paires clé-valeur qui définissent tous les en-têtes inclus lors de la signature de la demande. Chaque paire clé-valeur comprend les éléments suivants : * clé : chaîne de caractères. Nom de l'en-tête. * valeur : chaîne. Valeur de l'en-tête. {#HRAD-getHeaderMap__ul_adn_4qh_5jb} |
[Tableau 11. Renvoie]

{#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 );

Sortie :

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

Renvoie un objet contenant les paramètres de requête inclus lors de la signature de la demande.
{#HRAD-getQueryMap__table_ejx_gyy_vjb__entry__3}

| Nom | Type | Description |
|-|-|-|
| Aucun |   |   |
[Tableau 12. Paramètres]

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

| Type | Description |
|-|-|
| Objet | Paires clé-valeur qui définissent les paramètres de requête inclus lors de la signature de la demande. Chaque paire clé-valeur comprend les éléments suivants : * clé : chaîne de caractères. Nom du paramètre de requête. * valeur : chaîne. Valeur du paramètre de requête. {#HRAD-getQueryMap__ul_adn_4qh_5jb} |
[Tableau 13. Renvoie]

{#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"]);

Sortie :

    API Version is: v2

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

Renvoie l'état de la demande de signature.
{#HRAD-getStatus__table_pwx_3yy_vjb__entry__3}

| Nom | Type | Description |
|-|-|-|
| Aucun |   |   |
[Tableau 14. Paramètres]

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

| Type | Description |
|-|-|
| Chaîne | L'état de la demande en cours de signature. Valeurs possibles : * RÉUSSITE : le système a signé la demande avec succès. * ÉCHEC : le système n'a pas signé la demande. * IGNORÉ : le système a ignoré la signature, car les informations étaient incomplètes. {#HRAD-getStatus__ul_kfj_1f1_wjb} |
[Tableau 15. Renvoie]

{#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());

Sortie :

    Status is: SUCCESS

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

Renvoie un message détaillé sur la signature de la demande. Si la signature de la demande échoue, cette méthode renvoie le message d'erreur.
{#HRAD-getStatusMessage__table_obq_kyy_vjb__entry__3}

| Nom | Type | Description |
|-|-|-|
| Aucun |   |   |
[Tableau 16. Paramètres]

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

| Type | Description |
|-|-|
| Chaîne | Message concernant la signature de demande. Si la signature de la demande échoue, renvoie l'un des messages d'erreur suivants : * Les informations d'identification ne sont pas valides : vérifiez l'objet AuthCredential que vous avez utilisé pour signer la demande. Assurez-vous qu'un algorithme d'authentification est associé aux informations d'identification. Pour plus d'informations, consultez [Configurer un algorithme d'authentification](https://www.servicenow.com/docs/access?context=configure-authentication-algorithm&version=xanadu&pubname=xanadu-platform-security&ft:locale=en-US). * Les données de la demande sont vides. L'authentification de la demande est ignorée : vérifiez l'objet HttpRequestData, car les informations requises peuvent être manquantes. * Impossible de trouver le périmètre du script includes : vérifiez que l'enregistrement de l'algorithme d'authentification et le script includes associé utilisé pour signer la demande se trouvent dans le bon périmètre. {#HRAD-getStatusMessage__ul_vj2_ll1_wjb} |
[Tableau 17. Renvoie]

{#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());

Sortie :

    Status message is: credential is not valid.

## HttpRequestAuthedData : setCredentialValue(String credential_value) {#ariaid-title11}

Définit une valeur d'informations d'identification pour l'objet HttpRequestAuthedData.

Utilisez une valeur d'informations d'identification pour stocker un cookie, une signature ou toute autre valeur nécessaire pour un algorithme d'authentification. Par exemple, créez une étape Obtenir des informations de connexion (GCI) avec un script qui récupère et stocke un jeton à usage unique pour un appel REST ou SOAP.

Utilisez la méthode setCredentialValue() pour définir la pastille de données de valeur d'informations d'identification pour les étapes REST, SOAP et GCI dans Studio de workflow.
{#HRAD_setCredentialValue_S__table_srb_d1v_cqb__entry__3}

| Nom | Type | Description |
|-|-|-|
| credential_value | Chaîne | Texte de la valeur d'informations d'identification. |
[Tableau 18. Paramètres]

{#HRAD_setCredentialValue_S__table_srb_d1v_cqb} {#HRAD_setCredentialValue_S__table_trb_d1v_cqb__entry__2}

| Type | Description |
|-|-|
| Aucun |   |
[Tableau 19. Renvoie]

{#HRAD_setCredentialValue_S__table_trb_d1v_cqb}  
Cet exemple montre comment définir une valeur d'informations d'identification pour une étape GCI.

    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(directive String) {#ariaid-title12}

Définit s'il faut appliquer la signature à la demande signée dans l'en-tête, en tant que paramètre de requête ou en tant que valeur d'informations d'identification.
{#HRAD-setDirective_S__table_nxn_rcy_sjb__entry__3}

| Nom | Type | Description |
|-|-|-|
| directive | Chaîne | Indique s'il faut appliquer la signature à l'en-tête, au paramètre de requête ou à la valeur d'informations d'identification de la demande signée. Les valeurs comprennent : * `query` : applique la signature comme paramètre de requête. * `en-tête` : applique une signature à l'en-tête de la demande. * `credential_value ` : applique une signature à la valeur d'informations d'identification. {#HRAD-setDirective_S__ul_w2m_lzb_5jb} |
[Tableau 20. Paramètres]

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

| Type | Description |
|-|-|
| nul |   |
[Tableau 21. Renvoie]

{#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(état de la chaîne) {#ariaid-title13}

Définit l'état de la demande de signature.
{#HRAD-setStatus_S__table_pbr_4yy_vjb__entry__3}

| Nom | Type | Description |
|-|-|-|
| statut | Chaîne | L'état de la demande en cours de signature. Valeurs possibles : * `réussite` : le système a signé la demande avec succès. * `fail` : le système n'a pas signé la demande. * `ignoré` : le système a ignoré la signature, car les informations étaient incomplètes. {#HRAD-setStatus_S__ul_nbg_jr1_wjb} |
[Tableau 22. Paramètres]

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

| Type | Description |
|-|-|
| nul |   |
[Tableau 23. Renvoie]

{#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());

Sortie :

     Status is: FAIL

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

Définit un message d'état pour la signature de la demande.
{#HRAD-setStatusMessage_S__table_vt4_qyy_vjb__entry__3}

| Nom | Type | Description |
|-|-|-|
| statusMessage | Chaîne | Message à définir pour l'état de signature de la demande. |
[Tableau 24. Paramètres]

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

| Type | Description |
|-|-|
| nul |   |
[Tableau 25. Renvoie]

{#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());

Sortie :

    Status message is: The request was successfully signed.