Skip to content

Primären SDK-Authentifizierungsschlüssel festlegen

put

/app_group/sdk_authentication/primary

Verwenden Sie diesen Endpunkt, um einen SDK-Authentifizierungsschlüssel als Primärschlüssel für Ihre App festzulegen.

Voraussetzungen

Um diesen Endpunkt zu verwenden, benötigen Sie einen API-Schlüssel mit der Berechtigung sdk_authentication.primary.

Rate-Limit

Wir wenden auf diesen Endpunkt das standardmäßige Braze-Rate-Limit von 250.000 Anfragen pro Stunde an, wie in API-Rate-Limits dokumentiert.

Anfragetext

1
2

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

1
2
3
4

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

Anfrageparameter

Parameter Erforderlich Datentyp Beschreibung
app_id Erforderlich String Der API-Bezeichner der App.
key_id Erforderlich String Die ID des SDK-Authentifizierungsschlüssels, der als primär markiert werden soll.

Beispielanfrage

1
2
3
4
5
6
7

curl --location --request PUT 'https://rest.iad-01.braze.com/app_group/sdk_authentication/primary' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY' \
--data-raw '{
  "app_id": "01234567-89ab-cdef-0123-456789abcdef",
  "key_id": "abcdef12-3456-7890-abcd-ef1234567890"
}'

Antwort

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

Antwortparameter

Parameter Datentyp Beschreibung
keys Array Array mit allen SDK-Authentifizierungsschlüssel-Objekten.
keys[].id String Die ID des SDK-Authentifizierungsschlüssels.
keys[].rsa_public_key String Der String für den öffentlichen RSA-Schlüssel.
keys[].description String Beschreibung des SDK-Authentifizierungsschlüssels.
keys[].is_primary Boolescher Wert Ob dieser Schlüssel der primäre SDK-Authentifizierungsschlüssel ist.

Validierungsregeln

Für diesen Endpunkt gelten die folgenden Validierungsregeln:

  • Die key_id muss eine gültige ID eines SDK-Authentifizierungsschlüssels sein.
  • Die app_id muss ein gültiger API-Bezeichner der App sein.
  • Der SDK-Authentifizierungsschlüssel muss für die angegebene App existieren.
New Stuff!