Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Removed translated content for 'zh'
Sv translation
languageen

POST /domains/:domain_id/signParameters

Warning

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.

Info

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

Note

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

Resource Information

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.
Code Block
languagejs
{
  "parameters": {
    "myKey1": "myValue1",
    "parameterX": null
  }
}

Response

Signature string and security token separated by ;

Code Block
javascript
javascript
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
Sv translation
languageja

POST /domains/:domain_id/signParameters

Warning

このリソースはv2.9.8.1以降非推奨になりました。代わりにPOST Sign Resourceをご使用ください。


必要なサインパラメーターを作成します。

この機能は、エンドユーザーがURLパラメーターを変更する必要がある場合に便利です。

サインパラメーターは、プレーンダッシュボードと埋め込みビューでのみ使用できます。

Info

サインは、セキュリティを強化し、保護されたパラメーターを共有する柔軟性を提供します。


Note

このリソースは、グローバル管理者またはドメイン管理者用に利用可能です。

リソース情報

リクエストパラメーター

パラメーター

詳細

domain_id
(path parameter)

シグニチャが作成されるnamespaceドメインを識別します。


123

data
(form parameter)

次のJSON構造で送信するフォームコンテンツ:

説明
parameters

(任意) 各パラメーターがペアのkey-valueによって定義される場所に署名するためのすべてのパラメーターを含むJSONオブジェクト。



Code Block
languagejs
{
  "parameters": {
    "myKey1": "myValue1",
    "parameterX": null
  }
}


レスポンス

;で区切られた署名文字列とセキュリティトークン

Code Block
javascript
javascript
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