Skip to Content

Quickstarts

Ligue a sua aplicação para início de sessão via OpenID Connect, com guias de copiar e colar para o fluxo genérico, Node, Python e React.

Estes guias fazem com que uma aplicação passe a autenticar utilizadores através da plataforma por OpenID Connect (OIDC). Comece pelo fluxo genérico para perceber as peças envolvidas e avance depois para o guia que corresponde ao seu stack.

GuiaPara que serve
OpenID Connect (Authorization Code + PKCE)O protocolo em si, com HTTP simples e curl. Leia este guia primeiro; os restantes assentam nele.
Backend Node / ExpressUma aplicação web renderizada no servidor ou suportada por uma API, em Node.js.
Backend Python / FlaskUma aplicação web renderizada no servidor, em Python.
Aplicação de página única em ReactUma aplicação de browser sem backend próprio.
Cliente Financial-grade API (FAPI 2.0)Uma aplicação com um perfil de segurança FAPI 2.0: private key JWT, pushed authorization requests, DPoP.
Proteger uma APIO outro lado: validar os access tokens da plataforma na sua própria API e aplicar os scopes.

Para chamar a API REST de gestão da plataforma a partir de um serviço de backend (não para início de sessão de utilizadores), utilize antes o quickstart machine-to-machine em APIs.

Antes de começar

  1. Registe a sua aplicação. Na Admin Console, adicione uma aplicação e escolha o tipo de OIDC adequado à sua implementação: um cliente confidential para tudo o que tenha um backend capaz de guardar um segredo (Node/Express, Python/Flask), ou um cliente public para uma aplicação de página única ou nativa que não o consiga fazer. Consulte Aplicações.

  2. Tome nota das credenciais. Um cliente confidential tem um client ID e um client secret; um cliente public tem apenas um client ID e assenta em PKCE. Guarde o segredo no servidor, nunca em código do browser.

  3. Adicione o seu redirect URI. Registe o URL exato para o qual a plataforma devolve o utilizador após o início de sessão (por exemplo, https://app.example.com/callback). Os redirect URI são comparados carácter a carácter: esquema, host, porta, caminho e barra final têm de ser idênticos; não há suporte para wildcards.

  4. Conheça os seus endpoints. Tudo o que se segue pode ser descoberto no documento de configuração OpenID da sua instância:

    https://<your-domain>/.well-known/openid-configuration

    Substitua <your-domain> pelo domínio de início de sessão da sua instância (o seu domínio personalizado, caso exista; caso contrário, o host da plataforma). Este documento enumera authorization_endpoint, token_endpoint, userinfo_endpoint, jwks_uri e end_session_endpoint. Trate o documento de discovery como a fonte de verdade e deixe a sua biblioteca lê-lo, em vez de fixar os caminhos no código.

Vista geral dos endpoints

A título de orientação, estes são os caminhos padrão:

FinalidadeCaminho
Discovery/.well-known/openid-configuration
Autorização/authorize
Token/oauth/token
UserInfo/userinfo
Chaves de assinatura (JWKS)/.well-known/jwks
Terminar sessão (end session)/logout

O PKCE é obrigatório para clientes public e para aplicações com um perfil de segurança Financial-grade API, e S256 é o único método de challenge aceite. Utilize sempre Authorization Code com PKCE; o fluxo implicit não é recomendado.

Nesta página