Supprimer la clé d’authentification SDK
delete
/app_group/sdk_authentication/delete
Utilisez cet endpoint pour supprimer une clé d’authentification SDK pour votre application.
important:
La clé primaire ne peut pas être supprimée. Si vous tentez de supprimer la clé primaire, cet endpoint renverra une erreur.
Conditions préalables
Pour utiliser cet endpoint, vous aurez besoin d’une clé API avec l’autorisation sdk_authentication.delete
.
Limite de débit
Nous appliquons la limitation du débit Braze par défaut de 250 000 requêtes par heure à cet endpoint, comme documenté dans Limites de débit de l’API.
Corps de la demande
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 demande
Paramètre | Requis | Type de données | Description |
---|---|---|---|
app_id |
Requis | Chaîne de caractères | L’identifiant de l’API de l’application. |
key_id |
Requis | Chaîne de caractères | L’ID de la clé d’authentification SDK à supprimer. |
Exemple de demande
1
2
3
4
5
6
7
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"
}'
Réponse
1
2
3
4
5
6
7
8
9
10
{
"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
}
]
}
Paramètres de réponse
Paramètre | Type de données | Description |
---|---|---|
keys |
Tableau | Tableau d’objets de clés d’authentification SDK restants. |
keys[].id |
Chaîne de caractères | L’ID de la clé d’authentification du SDK. |
keys[].rsa_public_key |
Chaîne de caractères | Chaîne de caractères de la clé publique RSA. |
keys[].description |
Chaîne de caractères | Description de la clé d’authentification du SDK. |
keys[].is_primary |
Valeur booléenne | Indique si cette clé est la clé d’authentification principale du SDK. |
Règles de validation
Les règles de validation suivantes s’appliquent à cet endpoint :
- L’adresse
key_id
doit être un ID de clé d’authentification SDK valide. - L’adresse
app_id
doit être un identifiant d’API d’application valide. - La clé d’authentification SDK doit exister pour l’application spécifiée.
- La clé d’authentification SDK primaire ne peut pas être supprimée.
New Stuff!