Skip to content

SDK認証キーの一覧

get

/app_group/sdk_authentication/keys

このエンドポイントを使用して、アプリのすべてのSDK認証キーを取得します。

前提条件

このエンドポイントを使用するには、sdk_authentication.keys 権限を持つAPIキーが必要です。

レート制限

APIレート制限に記載されているように、このエンドポイントにはデフォルトのBrazeレート制限（1時間あたり250,000リクエスト）が適用されます。

リクエストパラメーター

パラメーター 必須 データタイプ 説明
app_id 必須 文字列 アプリのAPI識別子。

リクエスト例

1
2

curl --location --request GET 'https://rest.iad-01.braze.com/app_group/sdk_authentication/keys?app_id=01234567-89ab-cdef-0123-456789abcdef' \
--header 'Authorization: Bearer YOUR-REST-API-KEY'

応答

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

{
  "keys": [
    {
      "id": "abcdef12-3456-7890-abcd-ef1234567890",
      "rsa_public_key": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAvvD+fgA0YuCUd/v35htn...\n-----END PUBLIC KEY-----",
      "description": "SDK Authentication Key for iOS App",
      "is_primary": true
    },
    {
      "id": "fedcba98-7654-3210-fedc-ba9876543210",
      "rsa_public_key": "-----BEGIN PUBLIC KEY-----\nqWGfHOAiIwVzC/bTxwQZQQVzm/3ktgdNXRUDm5aIwVzCtxbNm5aIxOAiIwVzVHOA...\n-----END PUBLIC KEY-----",
      "description": "SDK Authentication Key for Android App",
      "is_primary": false
    }
  ]
}

応答パラメーター

パラメーター データタイプ 説明
keys 配列 SDK認証キーオブジェクトの配列。
keys[].id 文字列 SDK認証キーのID。
keys[].rsa_public_key 文字列 RSA公開キーの文字列。
keys[].description 文字列 SDK認証キーの説明。
keys[].is_primary ブール値 このキーがプライマリSDK認証キーであるかどうか。

バリデーションルール

このエンドポイントには以下のバリデーションルールがあります。

  • app_id パラメーターは有効なアプリAPI識別子である必要があります。
  • アプリはワークスペースに存在している必要があります。
New Stuff!