Definir a chave primária de autenticação do SDK
put
/app_group/sdk_authentication/primary
Use esse endpoint para definir uma chave de autenticação do SDK como a chave primária do seu app.
Pré-requisitos
Para usar esse endpoint, você precisará de uma chave de API com a permissão sdk_authentication.primary
.
Limite de taxa
Aplicamos o limite de frequência padrão da Braze de 250.000 solicitações por hora a esse endpoint, conforme documentado em Limites de frequência da API.
Corpo da solicitação
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"
}
Parâmetros de solicitação
Parâmetro | Obrigatória | Tipo de dados | Descrição |
---|---|---|---|
app_id |
Obrigatória | String | O identificador da API do app. |
key_id |
Obrigatória | String | A ID da chave de autenticação do SDK a ser marcada como primária. |
Exemplo de solicitação
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"
}'
Resposta
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
}
]
}
Parâmetros de resposta
Parâmetro | Tipo de dados | Descrição |
---|---|---|
keys |
Vetor | Vetor de todos os objetos de chave de autenticação do SDK. |
keys[].id |
String | A ID da chave de autenticação do SDK. |
keys[].rsa_public_key |
String | A string da chave pública RSA. |
keys[].description |
String | Descrição da chave de autenticação do SDK. |
keys[].is_primary |
Booleano | Se essa chave é a chave primária de autenticação do SDK. |
Regras de validação
Esse endpoint tem as seguintes regras de validação:
- O endereço
key_id
deve ser uma ID de chave de autenticação do SDK válida. - O endereço
app_id
deve ser um identificador válido da API do app. - A chave de autenticação do SDK deve existir para o app especificado.
New Stuff!