Skip to content

SDK-Authentifizierungsschlüssel erstellen

post

/app_group/sdk_authentication/create

Verwenden Sie diesen Endpunkt, um einen neuen SDK-Authentifizierungsschlüssel für Ihre App zu erstellen.

Voraussetzungen

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

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
5
6

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

Anfrageparameter

Parameter Erforderlich Datentyp Beschreibung
app_id Erforderlich String Der API-Bezeichner der App.
rsa_public_key_str Erforderlich String Der String für den öffentlichen RSA-Schlüssel. Muss ein gültiger öffentlicher RSA-Schlüssel sein, andernfalls wird ein Fehler zurückgegeben.
description Erforderlich String Beschreibung für den SDK-Authentifizierungsschlüssel.
make_primary Optional Boolescher Wert Wenn auf true gesetzt, wird dieser Schlüssel bei der Erstellung zum primären SDK-Authentifizierungsschlüssel.

Beispielanfrage

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

Antwort

1
2
3

{
  "id": "key id"
}

Antwortparameter

Parameter Datentyp Beschreibung
id String Die ID des neu erstellten SDK-Authentifizierungsschlüssels.

Validierungsregeln

Für diesen Endpunkt gelten die folgenden Validierungsregeln:

  • Sie können bis zu 3 SDK-Authentifizierungsschlüssel pro App haben.
  • Der RSA-Public-Key-String muss ein gültiger öffentlicher RSA-Schlüssel im richtigen Format sein.
  • Die app_id muss ein gültiger API-Bezeichner der App sein.
  • Die Beschreibung darf nicht leer sein.
New Stuff!