SDK 認証キーを削除

delete

/app_group/sdk_authentication/delete

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

important:

プライマリキーは削除できません。プライマリキーを削除しようとすると、このエンドポイントはエラーを返します。

前提条件

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

レート制限

API レート制限で説明されているように、このエンドポイントにはデフォルトの1時間あたり25万リクエストのBraze レート制限が適用されます。

要求本文:

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

{
  "app_id": "App API Identifier",
  "key_id": "key id"
}

リクエストパラメーター

パラメーター必須データタイプ説明

app_id 必須 string アプリの API 識別子。

key_id 必須 string 削除する SDK 認証キーの ID。

例のリクエスト

curl --location --request DELETE 'https://rest.iad-01.braze.com/app_group/sdk_authentication/delete' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY' \
--data-raw '{
  "app_id": "01234567-89ab-cdef-0123-456789abcdef",
  "key_id": "fedcba98-7654-3210-fedc-ba9876543210"
}'

応答

{
  "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
    }
  ]
}

応答パラメーター

パラメータデータタイプ説明

keys 配列残りの SDK 認証キーオブジェクトの配列。

keys[].id string SDK 認証キーの ID。

keys[].rsa_public_key string RSA 公開キーの文字列。

keys[].description string SDK 認証キーの説明。

keys[].is_primary ブール値このキーがプライマリ SDK 認証キーであるかどうか。

検証ルール

このエンドポイントには以下の検証ルールがあります。

key_id は有効な SDK 認証キー ID でなければならない。
app_id は有効なアプリ API 識別子でなければならない。
SDK 認証キーは、指定されたアプリに存在しなければならない。
プライマリ SDK 認証キーは削除できない。

GitHub でこのページを編集

「このページはどの程度役に立ちましたか?」

GitHub でこのページを編集

New Stuff!