Skip to content

Latest commit

 

History

History
62 lines (40 loc) · 2.79 KB

HMACSignaturesApi.md

File metadata and controls

62 lines (40 loc) · 2.79 KB
Raw

Zuora::HMACSignaturesApi

All URIs are relative to https://rest.zuora.com

Method HTTP request Description
post_hmac_signatures POST /v1/hmac-signatures Return HMAC signatures

post_hmac_signatures

POSTHMACSignatureResponseType post_hmac_signatures(request, opts)

Return HMAC signatures

This REST API reference describes how to return unique signature and token values that used to process a CORS enabled API call.

Example

# load the gem
require 'zuora'

api_instance = Zuora::HMACSignaturesApi.new

request = Zuora::POSTHMACSignatureType.new # POSTHMACSignatureType | 

opts = { 
  entity_id: "entity_id_example", # String | The Id of the entity that you want to access. Note that you must have permission to access the entity. For more information, see [REST Authentication](https://www.zuora.com/developer/api-reference/#section/Authentication/Entity-Id-and-Entity-Name).
  entity_name: "entity_name_example" # String | The [name of the entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity/B_Introduction_to_Entity_and_Entity_Hierarchy#Name_and_Display_Name) that you want to access. Note that you must have permission to access the entity. For more information, see [REST Authentication](https://www.zuora.com/developer/api-reference/#section/Authentication/Entity-Id-and-Entity-Name).
}

begin
  #Return HMAC signatures
  result = api_instance.post_hmac_signatures(request, opts)
  p result
rescue Zuora::ApiError => e
  puts "Exception when calling HMACSignaturesApi->post_hmac_signatures: #{e}"
end

Parameters

Name Type Description Notes
request POSTHMACSignatureType
entity_id String The Id of the entity that you want to access. Note that you must have permission to access the entity. For more information, see REST Authentication. [optional]
entity_name String The name of the entity that you want to access. Note that you must have permission to access the entity. For more information, see REST Authentication. [optional]

Return type

POSTHMACSignatureResponseType

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json; charset=utf-8
  • Accept: application/json; charset=utf-8