SDK 인증 키 삭제

delete

/app_group/sdk_authentication/delete

이 엔드포인트를 사용하여 앱의 SDK 인증 키를 삭제할 수 있습니다.

important:

기본 키는 삭제할 수 없습니다. 기본 키를 삭제하려고 하면 이 엔드포인트는 오류를 반환합니다.

Prerequisites

이 엔드포인트를 사용하려면 sdk_authentication.delete 권한이 있는 API 키가 필요합니다.

사용량 제한

API 속도 제한에 설명된 대로 이 엔드포인트에 시간당 250,000건의 기본 Braze 속도 제한을 적용합니다.

요청 본문

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

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

요청 매개변수

매개변수 필수 데이터 유형 설명

app_id 필수 문자열 앱 API 식별자입니다.

key_id 필수 문자열 삭제할 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 문자열 SDK 인증 키의 ID입니다.

keys[].rsa_public_key 문자열 RSA 공개 키 문자열입니다.

keys[].description 문자열 SDK 인증 키에 대한 설명입니다.

keys[].is_primary 부울 이 키가 기본 SDK 인증 키인지 여부입니다.

유효성 검사 규칙

이 엔드포인트에는 다음과 같은 유효성 검사 규칙이 있습니다:

key_id 은 유효한 SDK 인증 키 ID여야 합니다.
app_id 은 유효한 앱 API 식별자이어야 합니다.
지정된 앱에 대한 SDK 인증 키가 있어야 합니다.
기본 SDK 인증 키는 삭제할 수 없습니다.

GitHub 에서 이 페이지를 편집합니다.

이 페이지가 얼마나 도움이 되었나요?

GitHub 에서 이 페이지를 편집합니다.

New Stuff!