Skip to content

Définir la clé d’authentification SDK principale

put

/app_group/sdk_authentication/primary

Utilisez cet endpoint pour définir une clé d’authentification SDK comme clé principale pour votre application.

Conditions préalables

Pour utiliser cet endpoint, vous aurez besoin d’une clé API avec l’autorisation sdk_authentication.primary.

Limite de débit

La limite de débit par défaut de Braze de 250 000 requêtes par heure s’applique à cet endpoint, comme documenté dans Limites de débit de l’API.

Corps de la requête

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

Paramètres de requête

Paramètre Requis Type de données Description
app_id Requis Chaîne de caractères L’identifiant API de l’application.
key_id Requis Chaîne de caractères L’ID de la clé d’authentification SDK à marquer comme principale.

Exemple de requête

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

Réponse

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

Paramètres de réponse

Paramètre Type de données Description
keys Tableau Tableau de tous les objets de clés d’authentification SDK.
keys[].id Chaîne de caractères L’ID de la clé d’authentification SDK.
keys[].rsa_public_key Chaîne de caractères La chaîne de caractères de la clé publique RSA.
keys[].description Chaîne de caractères Description de la clé d’authentification SDK.
keys[].is_primary Valeur booléenne Indique si cette clé est la clé d’authentification SDK principale.

Règles de validation

Les règles de validation suivantes s’appliquent à cet endpoint :

  • Le key_id doit être un ID de clé d’authentification SDK valide.
  • Le app_id doit être un identifiant API d’application valide.
  • La clé d’authentification SDK doit exister pour l’application spécifiée.
New Stuff!