Skip to content

SDK認証キーを作成

post

/app_group/sdk_authentication/create

このエンドポイントを使用して、アプリ用の新しいSDK認証キーを作成します。

前提条件

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

レート制限

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

リクエスト本文

1
2

Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY

1
2
3
4
5
6

{
  "app_id": "App API identifier",
  "rsa_public_key_str": "RSA public key string",
  "description": "description",
  "make_primary": false
}

リクエストパラメーター

パラメーター 必須 データタイプ 説明
app_id 必須 文字列 アプリのAPI識別子。
rsa_public_key_str 必須 文字列 RSA公開キーの文字列。有効なRSA公開キーでなければならず、そうでない場合はエラーを返します。
description 必須 文字列 SDK認証キーの説明。
make_primary オプション ブール値 true に設定すると、作成時にこのキーがプライマリSDK認証キーになります。

リクエスト例

1
2
3
4
5
6
7
8
9

curl --location --request POST 'https://rest.iad-01.braze.com/app_group/sdk_authentication/create' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY' \
--data-raw '{
  "app_id": "01234567-89ab-cdef-0123-456789abcdef",
  "rsa_public_key_str": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAvvD+fgA0YuCUd/v35htn...\n-----END PUBLIC KEY-----",
  "description": "SDK Authentication Key for iOS App",
  "make_primary": false
}'

応答

1
2
3

{
  "id": "key id"
}

応答パラメーター

パラメーター データタイプ 説明
id 文字列 新しく作成されたSDK認証キーのID。

バリデーションルール

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

  • 1つのアプリにつきSDK認証キーは最大3つまで保持できます。
  • RSA公開キー文字列は、適切な形式の有効なRSA公開キーでなければなりません。
  • app_id は有効なアプリAPI識別子でなければなりません。
  • 説明を空にすることはできません。
New Stuff!