---
sourceDocument: Xanadu API Reference
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - en-US

ft:publication_title :

    - Xanadu API Reference

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# HttpRequestAuthedData - Scoped

# HttpRequestAuthedData - Scoped {#ariaid-title1}

* Release version: Xanadu
* 
* Updated August 1, 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 9 minutes to read

The HttpRequestAuthedData() API provides methods to access and set
values in a signed REST or SOAP request.  
Generate outbound signing requests using these APIs in the following order:

1. HttpRequestData: Build the API request.
2. AuthCredential: Create a credential object or update an existing one. Use the credential to sign the request through the RequestAuthAPI class.
3. RequestAuthAPI: Sign the request and return an HttpRequestAuthedData object.
4. HttpRequestAuthedData: Get information about the signed request.
5. GlideHTTPRequest: Send the signed request.
{#HttpRequestAuthedDataAPI__ol_gvv_22t_tjb}

Before using these APIs, you must [configure an authentication
algorithm](https://www.servicenow.com/docs/access?context=configure-authentication-algorithm&version=xanadu&pubname=xanadu-platform-security&ft:locale=en-US) to sign the request and associate it with the credential used to authenticate the request.

Use this API in scoped scripts with the `sn_auth` namespace identifier. You can instantiate this class using the constructor, or you can return an HttpRequestAuthedData object from the generateAuth() method in the RequestAuthAPI class.

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

Instantiates an HttpRequestAuthedData object.
You can instantiate this class using the constructor, or you can return an HttpRequestAuthedData object from the generateAuth() method in the RequestAuthAPI class.
{#HRAD-HttpRequestAuthedData__table_ug1_xxy_vjb__entry__3}

| Name | Type | Description |
|-|-|-|
| None |   |   |
[Table 1. Parameters]

{#HRAD-HttpRequestAuthedData__table_ug1_xxy_vjb}

## HttpRequestAuthedData - addHeader(String key, String value) {#ariaid-title3}

Adds a header to the HttpRequestAuthedData object.
{#HRAD-addHeader_S_S__table_fv4_zxy_vjb__entry__3}

| Name | Type | Description |
|-|-|-|
| key | String | Name of the HTTP header. |
| value | String | Value of the HTTP Header. |
[Table 2. Parameters]

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

| Type | Description |
|-|-|
| void |   |
[Table 3. Returns]

{#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(String key, String value) {#ariaid-title4}

Adds a query parameter to the HttpRequestAuthedData object.
{#HRAD-addQueryParam_S_S__table_fv4_zxy_vjb__entry__3}

| Name | Type | Description |
|-|-|-|
| key | String | Name of the query parameter. |
| value | String | Value of the query parameter. |
[Table 4. Parameters]

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

| Type | Description |
|-|-|
| void |   |
[Table 5. Returns]

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

Returns the credential value that was included when the request was signed.
Use a credential value to store a cookie, signature, or other value needed for an authentication algorithm. For example, create a Get Connection Info (GCI) step with a script that retrieves and stores a one-time token for a REST or SOAP call.
{#HRAD-getCredentialValue__table_b5h_b1v_cqb__entry__3}

| Name | Type | Description |
|-|-|-|
| None |   |   |
[Table 6. Parameters]

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

| Type | Description |
|-|-|
| String | Text of the credential value. |
[Table 7. Returns]

{#HRAD-getCredentialValue__table_c5h_b1v_cqb}  
This example shows the retrieval of a credential value.

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

Output:

    The Credential Value is someUsername:somePassword

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

Returns whether the signature is applied to the request in the header, as a query
parameter, or as a credential value.
By default, the system applies the signature to the header. You can apply the signature as
a query parameter or credential value by using the setDirective()
API.
{#HRAD-getDirective__table_kmr_dyy_vjb__entry__3}

| Name | Type | Description |
|-|-|-|
| None |   |   |
[Table 8. Parameters]

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

| Type | Description |
|-|-|
| String | Whether the signature is applied to the header, as a query parameter, or as a credential value. Values include: * HEADER: The signature is applied to the request header. * QUERY: The signature is applied as a query parameter. * CREDENTIAL_VALUE: The signature is applied as a credential value. {#HRAD-getDirective__ul_xdw_v5b_5jb} |
[Table 9. Returns]

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

Output:

    Signature applied to: HEADER

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

Returns an object containing the headers that were included when the request was
signed.
{#HRAD-getHeaderMap__table_w3n_fyy_vjb__entry__3}

| Name | Type | Description |
|-|-|-|
| None |   |   |
[Table 10. Parameters]

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

| Type | Description |
|-|-|
| Object | Key-value pairs that define all of the headers included when the request was signed. Each key-value pair includes these parts: * key: String. Name of the header. * value: String. Value of the header. {#HRAD-getHeaderMap__ul_adn_4qh_5jb} |
[Table 11. Returns]

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

Output:

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

Returns an object containing the query parameters included when the request was
signed.
{#HRAD-getQueryMap__table_ejx_gyy_vjb__entry__3}

| Name | Type | Description |
|-|-|-|
| None |   |   |
[Table 12. Parameters]

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

| Type | Description |
|-|-|
| Object | Key-value pairs that define the query parameters included when the request was signed. Each key-value pair includes these parts: * key: String. Name of the query parameter. * value: String. Value of the query parameter. {#HRAD-getQueryMap__ul_adn_4qh_5jb} |
[Table 13. Returns]

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

Output:

    API Version is: v2

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

Returns the status of the request signing.
{#HRAD-getStatus__table_pwx_3yy_vjb__entry__3}

| Name | Type | Description |
|-|-|-|
| None |   |   |
[Table 14. Parameters]

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

| Type | Description |
|-|-|
| String | The status of the request signing. Possible values: * SUCCESS: The system successfully signed the request. * FAIL: The system failed to sign the request. * SKIPPED: The system skipped signing because the information was incomplete. {#HRAD-getStatus__ul_kfj_1f1_wjb} |
[Table 15. Returns]

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

Output:

    Status is: SUCCESS

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

Returns a detailed message about the request signing. If the request signing fails,
this method returns the error message.
{#HRAD-getStatusMessage__table_obq_kyy_vjb__entry__3}

| Name | Type | Description |
|-|-|-|
| None |   |   |
[Table 16. Parameters]

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

| Type | Description |
|-|-|
| String | Message about the request signing. If the request signing fails, returns one of these error messages: * credential is not valid: Check the AuthCredential object you used to sign the request. Make sure an authentication algorithm is associated with the credential. For more information, see [Configure an authentication algorithm](https://www.servicenow.com/docs/access?context=configure-authentication-algorithm&version=xanadu&pubname=xanadu-platform-security&ft:locale=en-US). * Request data is empty. Request auth is skipped: Check the HttpRequestData object because required information may be missing. * Can't find script includes scope: Verify that the authentication algorithm record and associated script includes used to sign the request are in the correct scope. {#HRAD-getStatusMessage__ul_vj2_ll1_wjb} |
[Table 17. Returns]

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

Output:

    Status message is: credential is not valid.

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

Sets a credential value for the HttpRequestAuthedData object.

Use a credential value to store a cookie, signature, or other value needed for an authentication algorithm. For example, create a Get Connection Info (GCI) step with a script that retrieves and stores a one-time token for a REST or SOAP call.

Use the setCredentialValue() method to set the Credential Value data pill for REST, SOAP, and GCI steps in Workflow Studio.
{#HRAD_setCredentialValue_S__table_srb_d1v_cqb__entry__3}

| Name | Type | Description |
|-|-|-|
| credential_value | String | Text of the credential value. |
[Table 18. Parameters]

{#HRAD_setCredentialValue_S__table_srb_d1v_cqb} {#HRAD_setCredentialValue_S__table_trb_d1v_cqb__entry__2}

| Type | Description |
|-|-|
| None |   |
[Table 19. Returns]

{#HRAD_setCredentialValue_S__table_trb_d1v_cqb}  
This example shows how to set a credential value for a GCI step.

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

Defines whether to apply the signature to the signed request in the header, as a query
parameter, or as a credential value.
{#HRAD-setDirective_S__table_nxn_rcy_sjb__entry__3}

| Name | Type | Description |
|-|-|-|
| directive | String | Whether to apply the signature to the header, query parameter, or credential value of the signed request. Values include: * `query`: Applies signature as a query parameter. * `header`: Applies signature to the request header. * `credential_value` : Applies signature to the credential value. {#HRAD-setDirective_S__ul_w2m_lzb_5jb} |
[Table 20. Parameters]

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

| Type | Description |
|-|-|
| void |   |
[Table 21. Returns]

{#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(String status) {#ariaid-title13}

Sets the status of the request signing.
{#HRAD-setStatus_S__table_pbr_4yy_vjb__entry__3}

| Name | Type | Description |
|-|-|-|
| status | String | The status of the request signing. Possible values: * `success`: The system successfully signed the request. * `fail`: The system failed to sign the request. * `skipped`: The system skipped signing because the information was incomplete. {#HRAD-setStatus_S__ul_nbg_jr1_wjb} |
[Table 22. Parameters]

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

| Type | Description |
|-|-|
| void |   |
[Table 23. Returns]

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

Output:

     Status is: FAIL

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

Sets a status message for the request signing.
{#HRAD-setStatusMessage_S__table_vt4_qyy_vjb__entry__3}

| Name | Type | Description |
|-|-|-|
| statusMessage | String | Message to set for the request signing status. |
[Table 24. Parameters]

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

| Type | Description |
|-|-|
| void |   |
[Table 25. Returns]

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

Output:

    Status message is: The request was successfully signed.