Registo de aplicação OAuth 2.0

O registo de aplicação OAuth 2.0 do FoxIDs permite-lhe ligar APIs como recursos OAuth 2.0 e ligar o seu serviço backend usando Client Credentials Grant.

FoxIDs OAuth 2.0 application registration

Recurso OAuth 2.0

Uma API é configurada como recurso de um registo de aplicação OAuth 2.0.

Clique em New application e depois em OAuth 2.0 - Resource (API)
Especifique o nome do recurso (API) no nome do registo de aplicação.
Especifique um ou mais scopes.

Resource with scopes

Depois, pode ser concedido acesso a um cliente configurando resource and scopes no cliente.

Client Credentials Grant

Uma aplicação que usa Client Credentials Grant pode ser um serviço backend protegido por client id e secret ou chave.

Clique em New application e depois em OAuth 2.0 - Client Credentials Grant
Especifique o nome do cliente no nome do registo de aplicação.
Especifique o método de autenticação do cliente, por predefinição client secret post
- Um secret é gerado por predefinição
- Opcionalmente altere para outro método de autenticação do cliente
  - Selecione show advanced
  - Selecione o método de autenticação do cliente: client secret basic ou private key JWT
  - Se private key JWT estiver selecionado, carregue um certificado de cliente (ficheiro pfx)
Opcionalmente conceda ao cliente acesso para chamar o recurso (API) party-api2 com os scopes read1 e read2.

Configure Client Credentials Grant

Access tokens podem ser emitidos com uma lista de audiences e, assim, serem emitidos para várias APIs definidas no FoxIDs como recursos OAuth 2.0.

Pode modificar claims e executar claim tasks com transformações e tarefas de claims.

Autenticar com certificado como credencial do cliente

O cliente pode autenticar-se com um certificado se private key JWT estiver selecionado como método de autenticação do cliente e tiver sido carregado um certificado de cliente.

Exemplo de pedido POST Client Credentials Grant com private key JWT para o endpoint token:

POST https://foxids.com/test-corp/-/my-backend-client(*)/oauth/token HTTP/1.1
Host: foxids.com
Content-Type: application/x-www-form-urlencoded

client_assertion_type=urn%3Aietf%3Aparams%3Aoauth%3Aclient-assertion-type%3Ajwt-bearer
&client_assertion=eyJhbGcrOiI...kyX3NhbXBsZS
&grant_type=client_credentials
&scope=party-api2%3Aread1

Client secret

É importante armazenar client secrets em segurança; por isso, os client secrets são hashed no FoxIDs com o mesmo algoritmo de hash usado para palavras-passe. Se o secret tiver mais de 20 caracteres, o que deveria acontecer, os primeiros 3 caracteres são guardados como informação e mostrados para cada secret no FoxIDs Control.

Resource Owner Password Credentials Grant

Resource Owner Password Credentials Grant não é suportado por razões de segurança, porque é inseguro e não deve ser usado.