JWT

De Banane Atomic
Aller à la navigationAller à la recherche

Description

JSON Web Token

Access token (authorization)

Access tokens are used to inform an API that the bearer of the token has been authorized to access the API and perform a predetermined set of actions specified by the scope. It is used to authorize API access.
The token is generated after a user successfully authenticates and authorizes access.
It does not contain any information about the user itself besides their ID (sub).
It only contains authorization information about which actions the application is allowed to perform at the API (scope).
This is what makes it useful for securing an API, but not for authenticating a user.
An access token is put in the Authorization header of your request, then the API verifies the token and grant access regarding the scope.

token key description
scope list of authorized accesses
sub subject: unique identifier of the user

ID token (authentication)

The ID token is used to retrieve the user’s basic profile information like name, DOB, email, and phone, which is present in the authentication server.
It should not be used to gain access to an API.
OpenID Connect always issues ID tokens along with access tokens to provide compatibility with OAuth.
ID token carries personal information about end-users that authenticate on an OpenID Connect flow.

token key description
aud audience: an id of the application that should consume the token
auth_time date of the authentication
iss url of the issuer of the token (AWS cognito, AAD)
sub subject: unique identifier of the user

Refresh token

The refresh token is used to request new access tokens without user interaction.

Token keys

token key description
auth_time date of the authentication (nb of seconds since Epoch: 1970-01-01T00:00:00Z UTC)
exp expiration time
iat issued at: token creation date
iss url of the issuer of the token (AWS cognito, AAD)

Azure

acr Authentication Context class Reference 0 : l'authentification ne respecte pas la norme ISO/IEC 29115
amr Authentication Method pwd
appid APPlication ID Application ID dans Azure AD Applications
appidacr APPlication Authentication Context class Reference
  • 0 : client publique
  • 1 : si le client ID et le client secret sont utilisés
oid Object ID ID unique de l'utilisateur
scp Scope user_impersonation
tid Tenant ID

Scopes

scope description
openid generate an ID token, authorizes the unique-identifier claim sub, and the ability to request other scopes
profile authorizes all user attributes that the app client can read
email authorizes the user attributes email and email_verified
phone authorizes the user attributes phone_number and phone_number_verified