OneSignal.login para que um cliente não possa se passar por outro External ID. O mesmo token pode autorizar a adição de assinaturas de e-mail e SMS e determinadas chamadas à User REST API.
A verificação de identidade está disponível para todos nos SDKs nativos para Android e iOS e no SDK Web. Ela ainda não é compatível com SDKs multiplataforma (por exemplo, Flutter, React Native etc.).
SDKs compatíveis \
login. O suporte a eles chegará em breve.
Ative a verificação de identidade para proteger:
- O login de usuários
- A adição de assinaturas de e-mail
- A adição de assinaturas de SMS
- A modificação de identidades e aliases de usuários
Pré-requisitos \
- Um aplicativo OneSignal existente com uma plataforma push configurada.
- Todo cliente que chama
loginusa um SDK compatível: o SDK nativo para Android 5.9.0+, o SDK nativo para iOS 5.8.0+ ou o SDK Web 160900+. - Um backend que autentica seus usuários e pode assinar JWTs.
- Acesso a Settings > Keys & IDs no painel do OneSignal. A seção Identity Verification está disponível para todos os aplicativos. Você não precisa entrar em contato com o suporte.
Gerar chaves \
Conclua estas etapas em ordem: gere as chaves, crie o JWT e depois adicione-o ao seu aplicativo. Não ative a chave Token Identity Verification até que seu backend consiga emitir JWTs e seu aplicativo consiga passá-los paralogin.
Faça login na sua conta do OneSignal e acesse Settings > Keys & IDs > Identity Verification.

Configuração da verificação de identidade

Criação de um novo par de chaves

Par de chaves de verificação de identidade
Criar o JWT \
Autentique o usuário com seu próprio servidor antes de assinar um token. Quando essa autenticação for bem-sucedida, assine um JWT ES256 com as claims abaixo e retorne-o ao dispositivo na sua resposta de autenticação. Se o seu aplicativo não tiver backend, configure um pequeno servidor cuja única função seja verificar usuários e assinar esses tokens. Nunca assine JWTs no dispositivo.Payload do JWT \
Assinar o JWT \
Assine o JWT com o algoritmo ES256 (ECDSA usando P-256 e SHA-256). Outros algoritmos são rejeitados. Use uma biblioteca de JWT em vez de montar o token manualmente. Exemplo usando jsonwebtoken. Passe a chave privada PEM que você baixou na etapa anterior:Verificar seu JWT \
Registre ou retorne a string designOneSignalJWT() e depois decodifique-a para confirmar o payload. O jwt.io decodifica tokens no seu navegador, mas trate o token de um usuário real como um segredo e use um token de teste ao colá-lo em ferramentas de terceiros. O payload decodificado deve ter esta aparência:
login:
isscorresponde ao seu App ID do OneSignal em Settings > Keys & IDsidentity.external_idcorresponde ao valor que você passará paraOneSignal.login()expestá no futuro e expresso em segundos
Incluir assinaturas \
Inclua o e-mail e o SMS no JWT no login quando você já tiver esses valores. Se eles chegarem depois, emita um novo JWT que inclua a claimsubscriptions e passe-o para updateUserJwt antes de chamar addEmail ou addSms. Consulte Adicionar assinaturas.
Adicionar o JWT ao seu aplicativo \
Conclua estas etapas no seu aplicativo ou site.Passe o JWT para o método login
login com o External ID e o JWT. Até que o Token Identity Verification seja ativado no painel, o SDK não envia o JWT, então você pode publicar esta atualização do aplicativo antes de ativar a chave. Depois de ativar a chave, login sem um JWT válido falha.login(external_id, profile). Inclua o e-mail e o número de telefone do perfil na claim subscriptions do JWT. Consulte Adicionar assinaturas.loginResult falha com BACKEND_ERROR e o status HTTP 401, e o SDK dispara o evento de JWT invalidado descrito na próxima etapa. O SDK mantém o login na fila e tenta novamente depois que você chama updateUserJwt.Trate os eventos do ciclo de vida do JWT
updateUserJwt. As solicitações que precisam do token aguardam até que você o forneça. Você pode usar o mesmo endpoint para emitir um token que inclua o e-mail ou o SMS se o token de login original não os incluía.Adicione o listener na inicialização do aplicativo, antes de chamar login:- Android: adicione-o em
Application.onCreate. O listener só recebe eventos disparados depois de ser adicionado e é chamado em uma thread em segundo plano. - iOS: o SDK mantém uma referência fraca ao listener, então mantenha uma referência forte a ele. Ele é chamado na thread principal, então busque o token de forma assíncrona. Se um evento foi disparado antes de você adicionar o listener, o SDK o entrega quando você adiciona o listener.
- Web: adicione-o com
OneSignal.User.addEventListener("userJwtInvalidated", listener)dentro deOneSignalDeferred.push, antes de chamarlogin. O listener só recebe eventos disparados depois de ser adicionado. O SDK chama cada listener de forma assíncrona, e um listener que lança uma exceção não impede os outros listeners.
fetchOneSignalJwt por uma chamada ao seu backend. Não assine JWTs no dispositivo.Com esse listener implementado, um token expirado é substituído automaticamente e a sessão continua sem forçar o usuário a fazer login novamente.Ative o Token Identity Verification no painel

Ativação do Token Identity Verification
- Nenhum cliente deste aplicativo usa um SDK multiplataforma. Consulte SDKs compatíveis.
- A maioria dos seus usuários está em uma versão do aplicativo que passa um JWT para
login. Versões antigas do aplicativo ainda instaladas nos dispositivos não conseguem enviar um JWT, então as solicitações delas também falham. - Seu servidor envia um JWT para as User REST APIs que ele chama.
login ou a uma REST API protegida que não inclua um JWT válido. Consulte O que muda quando a chave está ativada.O que muda quando a chave está ativada \
- Login:
loginexige um JWT válido cujoidentity.external_idcorresponda ao External ID. - Dispositivos desconectados: o SDK não cria usuários anônimos no OneSignal. Em uma nova instalação, o dispositivo não registra uma assinatura push até que o aplicativo chame
logincom um JWT válido, então ele não pode receber notificações push antes disso. Se você envia push para usuários antes de eles fazerem login, planeje isso antes de ativar a chave. - Logout:
logout()desativa a assinatura push do dispositivo. Chamarlogincom um JWT a restaura. Consulte as perguntas frequentes. - E-mail e SMS:
addEmaileaddSmsexigem um JWT que inclua o endereço na claimsubscriptions. Consulte Adicionar assinaturas. - REST API: os endpoints de User e Subscription exigem
Authorization: Bearer YOUR_ONESIGNAL_JWT. Consulte REST API.
Adicionar assinaturas \
Se o JWT de login já incluir o e-mail ou o número de telefone emsubscriptions, login associa essas assinaturas ao usuário. Você não precisa de uma segunda chamada.
No Android 5.11.0 e posteriores, login(external_id, profile) envia o e-mail e o número de telefone do perfil na solicitação de login. Inclua cada um desses endereços na claim subscriptions do JWT de login.
Se o endereço ainda não estiver no JWT, emita um novo token que o inclua, chame updateUserJwt e depois chame addEmail ou addSms. Faça isso em todas as plataformas. addEmail / addSms sozinhos não bastam depois que o Token Identity Verification estiver ativado.
fetchOneSignalJwtWithEmail e fetchOneSignalJwtWithSms são marcadores para a sua própria chamada ao backend que emite um JWT com a claim subscriptions.
- Adicionar um e-mail
- Adicionar um número de telefone
REST API \
JWTs de verificação de identidade não são App API keys. Outros endpoints (por exemplo, Create message) continuam usandoAuthorization: Key YOUR_APP_API_KEY. Consulte Keys & IDs.
Quando o Token Identity Verification está ativado, os endpoints de User e Subscription abaixo se autenticam com o JWT de identidade:
login do SDK. O identity.external_id do token deve corresponder ao usuário sobre o qual a solicitação opera.
- Create user
- View user
- Update user
- Delete user
- View user identity
- Create alias
- Delete alias
- Create subscription
- Update subscription
Solução de problemas \
Perguntas frequentes \
A verificação de identidade é obrigatória? \
Não, mas ela é altamente recomendada para aplicativos em produção. Sem ela, qualquer cliente que conheça o External ID de um usuário pode se passar por esse usuário e modificar as assinaturas ou os dados dele.O que é a chave “Identity Verification for email + external_id”? \

Chave legada Identity Verification em Keys & IDs
Quais SDKs são compatíveis com a verificação de identidade? \
O SDK nativo para Android 5.9.0+, o SDK nativo para iOS 5.8.0+ e o SDK Web 160900+. SDKs multiplataforma (React Native, Expo, Flutter, Unity, Cordova, Ionic, Capacitor e .NET MAUI) ainda não são compatíveis. Consulte SDKs compatíveis.Meu aplicativo usa um SDK multiplataforma. Posso ativar a verificação de identidade? \
Ainda não. O painel permite ativar a chave, mas seus clientes não conseguem enviar um JWT, então os logins e as atualizações de assinaturas deles falham. Você pode gerar chaves e implementar a assinatura de JWTs no seu servidor agora e ativar a chave quando seu SDK for compatível.Qual algoritmo o JWT usa? \
ES256 (ECDSA usando P-256 e SHA-256). Outros algoritmos são rejeitados.O que acontece se o JWT expirar durante uma sessão? \
O SDK dispara um evento de JWT invalidado. ImplementeaddUserJwtInvalidatedListener (consulte Adicionar o JWT ao seu aplicativo) para buscar um novo token e passá-lo para updateUserJwt. Na web, escute o evento userJwtInvalidated com OneSignal.User.addEventListener.
Preciso da verificação de identidade para a REST API? \
Somente depois de ativar o Token Identity Verification. A partir daí, os endpoints de User e Subscription exigemAuthorization: Bearer YOUR_ONESIGNAL_JWT. Eles não aceitam a App API key para essas chamadas. Create message e outros endpoints que não são de usuário continuam usando Authorization: Key YOUR_APP_API_KEY.
O que acontece com a assinatura push no logout? \
Quando a verificação de identidade está ativada,logout() desativa a assinatura push. A assinatura continua associada a esse usuário. Chamar login com um JWT restaura o status anterior da assinatura. Você não precisa chamar optIn() novamente.
No Android (Kotlin), logoutSuspend() é o equivalente não bloqueante de logout().