SDKシークレットエンドポイント

SDKシークレットエンドポイントを使用して、アプリのSDKシークレットを管理します。古いシークレットの無効化、特定のシークレットの無効化、または以前に無効にしたシークレットの再有効化が可能です。

古いシークレットを無効にする

指定したバージョンより古いすべてのSDKシークレットを無効にします。これにより、新しいSDKシグネチャーバージョンに移行した後、古いシークレットをクリーンアップできます。

APIプロトコル

エンドポイント： https://automate.adjust.com/app-automation/app/{app_token}/secrets/revoke_outdated

メソッド： POST

リクエストボディ： 古いリクエストの無効化

レスポンス: 古いレスポンスの無効化

パラメーター

パラメーター	データタイプ	入力する値	必須	説明
`app_token`	`String`	パス	はい	Adjustアプリトークン。
`min_active_version`	`Integer`	ボディ	いいえ	有効にするための最小バージョン。これより古いシークレットは無効になります。デフォルトは`3`です。
`force`	`Boolean`	ボディ	いいえ	アクティブなシークレットがない場合でもシークレットを取り消す場合は、`true`に設定します。デフォルトは`false`です。

注記

min_active_version より古い バージョンのシークレットは無効になります。
無効にすることで 有効なシークレットが残らない 場合、force: trueが設定されていない限り、操作は失敗します。
デフォルトのmin_active_versionが3だった場合は、v1とv2のシークレットが無効になり、v3のシークレットのみが有効のままとなります。

例

v3より古いシークレットをすべて無効化

curl --location 'https://automate.adjust.com/app-automation/app/abc123xyz/secrets/revoke_outdated' \
--header 'Authorization: Bearer {your-adjust-api-token}' \
--header 'Content-Type: application/json' \
--data '{
    "min_active_version": 3
}'

{
   "combined_secrets": {
      "enforce_install_signing": true,
      "secrets": [
         {
            "id": 1001,
            "name": "Legacy Secret",
            "active": false,
            "value": ["secret1", "secret2", "info1", "info2"],
            "internal_version": 3,
            "version": 2,
            "created_at": "2023-01-15T10:30:00Z",
            "updated_at": "2024-06-15T14:00:00Z"
         },
         {
            "id": 2001,
            "platform": "android",
            "label": "Android SDK Secret",
            "active": true,
            "algorithm": "adj1",
            "internal_version": "3.47.0",
            "version": 3,
            "created_at": "2024-06-01T12:00:00Z",
            "updated_at": "2024-06-01T12:00:00Z"
         }
      ]
   },
   "revoked": 1
}

有効なシークレットが残っていない場合でも強制的に無効化

curl --location 'https://automate.adjust.com/app-automation/app/abc123xyz/secrets/revoke_outdated' \
--header 'Authorization: Bearer {your-adjust-api-token}' \
--header 'Content-Type: application/json' \
--data '{
    "min_active_version": 3,
    "force": true
}'

特定のシークレットを無効化

IDを使って特定のSDKシークレットを無効にできます。この操作により、シークレットは直ちに無効になります。

APIプロトコル

エンドポイント： https://automate.adjust.com/app-automation/app/{app_token}/secrets/{secret_id}/revoke

メソッド： POST

レスポンス： 成功時に、HTTP 202 Acceptedを返します。

パラメーター

パラメーター	データタイプ	入力する値	必須	説明
`app_token`	`String`	パス	はい	Adjustアプリトークン。
`secret_id`	`Integer`	パス	はい	無効にするシークレットのID。

例

curl --location --request POST 'https://automate.adjust.com/app-automation/app/abc123xyz/secrets/1001/revoke' \
--header 'Authorization: Bearer {your-adjust-api-token}'

HTTP/1.1 202 Accepted

シークレットを再有効化

無効にしたSDKシークレットの再有効化を行います。これにより、シークレットを再び利用できます。

APIプロトコル

エンドポイント： https://automate.adjust.com/app-automation/app/{app_token}/secrets/{secret_id}/reactivate

メソッド： POST

レスポンス： 成功時に、HTTP 202 Acceptedを返します。

パラメーター

パラメーター	データタイプ	入力する値	必須	説明
`app_token`	`String`	パス	はい	Adjustアプリトークン。
`secret_id`	`Integer`	パス	はい	再有効化するシークレットのID。

例

curl --location --request POST 'https://automate.adjust.com/app-automation/app/abc123xyz/secrets/1001/reactivate' \
--header 'Authorization: Bearer {your-adjust-api-token}'

HTTP/1.1 202 Accepted

すべてのシークレットを表示

1つのアプリ内のすべてのSDKシークレットを表示するには、combined_secretsセクションを含むアプリ設定エンドポイントを使用します。

curl --location 'https://automate.adjust.com/app-automation/app/abc123xyz/settings?sections=combined_secrets' \
--header 'Authorization: Bearer {your-adjust-api-token}'

{
   "combined_secrets": {
      "enforce_install_signing": true,
      "secrets": [
         {
            "id": 1001,
            "name": "Legacy Secret v2",
            "active": true,
            "value": ["secret1", "secret2", "info1", "info2"],
            "internal_version": 3,
            "version": 2,
            "created_at": "2023-01-15T10:30:00Z",
            "updated_at": "2023-01-15T10:30:00Z"
         },
         {
            "id": 2001,
            "platform": "android",
            "label": "Android SDK Secret",
            "active": true,
            "algorithm": "adj1",
            "internal_version": "3.47.0",
            "version": 3,
            "created_at": "2024-06-01T12:00:00Z",
            "updated_at": "2024-06-01T12:00:00Z"
         },
         {
            "id": 2002,
            "platform": "ios",
            "label": "iOS SDK Secret",
            "active": true,
            "algorithm": "adj1",
            "internal_version": "3.47.0",
            "version": 3,
            "created_at": "2024-06-01T12:00:00Z",
            "updated_at": "2024-06-01T12:00:00Z"
         }
      ]
   }
}

データモデル

古いリクエストの無効化

パラメーター	データタイプ	説明
`min_active_version`	`Integer`	有効にするための最小バージョン。これより古いシークレットは無効になります。デフォルトは`3`です。
`force`	`Boolean`	有効なシークレットがない場合でも、シークレットを取り消します。デフォルトは`false`です。

古いレスポンスの無効化

パラメーター	データタイプ	説明
`combined_secrets`*	`Object`	無効化の後に更新されたシークレットの状態。
`revoked`*	`Integer`	無効になったシークレットの数。

シークレットの組み合わせ

パラメーター	データタイプ	説明
`enforce_install_signing`*	`Boolean`	署名のないインストールを拒否するかどうか。
`secrets`*	`Array[Object]`	レガシー版を含むすべてのSDKシークレットのリスト。

レガシーシークレット

パラメーター	データタイプ	説明
`id`*	`Integer`	シークレットID。
`name`	`String`	シークレット名/ラベル。
`active`*	`Boolean`	シークレットがアクティブかどうか。
`value`*	`Array[String]`	シークレットの値（4つの要素）。
`internal_version`*	`Integer`	SDKシグネチャーライブラリのバージョン。
`version`*	`Integer`	SDKシークレットのバージョン（`1`または`2`）。
`created_at`*	`String`	シークレット作成時のISO形式のdatetime。
`updated_at`*	`String`	シークレット最終更新時のISO形式のdatetime。

SDKシークレット

パラメーター	データタイプ	説明
`id`*	`Integer`	シークレットID。
`platform`*	`String`	ターゲットプラットフォーム（`android`または`ios`）。
`label`*	`String`	シークレットのための人間が理解可能なラベル。
`active`*	`Boolean`	シークレットがアクティブかどうか。
`algorithm`*	`String`	シグネチャーアルゴリズムを使用。
`internal_version`*	`String`	SDKシグネチャーライブラリのバージョン。
`version`*	`Integer`	SDKシークレットのバージョン（3以降）。
`created_at`*	`String`	シークレット作成時のISO形式のdatetime。
`updated_at`*	`String`	シークレット最終更新時のISO形式のdatetime。