POST /domains/:domain_id/signParameters

This resource is deprecated since 2.9.8.1. User POST Sign Resource instead.

 

Creates the signature of desired parameters.

This feature is useful, when you need to ensure, that URL parameters are be changed by end user. 

Sign parameters is available for plain dashboard and embedded views only.

Signatures are helping to achieve more security and gives flexibility of sharing protected parameters.

This resource is available only for Global admin or Domain admin.

Resource Information

Resource URL

https://service.belladati.com/api/domains/:domain_id/signParameters

HTTP Method

POST

Request Parameters

Parameters

Detail

Example

domain_id
(path parameter)

Identifies the domain namespace the signature is created for.

 

123

data
(form parameter)

Form content to submit in following JSON structure:

NameDescription
parameters(Optional) JSON object containing all parameters to sign where each parameter is defined by pair key-value.
{
  "parameters": {
    "myKey1": "myValue1",
    "parameterX": null
  }
}

Response

Signature string and security token separated by ;

szZexlZ9Ax4u1s02f2BZmO2FqVmQqrmUhdHRL8Cp7uA=;Epu3khIq5DVe+zH0ap2pipXGSv+/RlOtzfZno6LfbQk=

Usage

Response is two strings (p and s paramter) separated by "p;s".

URLEncode p and s and to the URL, example:
http://belladati/bi/dashboard/plain/1?parameter1=value1&p=f2EJk1GtmRHUJSsyn5P7tkFJkiobCZPJ54omPM4Nwqt7jEYxNeq74g%3D%3D&s=8HZ%2BXSf8nj8W8xGSYuxJpm%2BBUg8qqZi8SQZ2JVoyvWM%3D

What is verified:

  • parameter names and values - in any order, but case sensitive. Only parameters passed to signParameters REST endpoints are verified - you can add additional parameters without signing them, but they won't be validated.
  • domain of the user (current user or owner of the embedded view sharing) - must equal to domain_id
  • No labels