decode_jwt {AzureAuth}

Get raw access token (which is a JWT object)

Description

Get raw access token (which is a JWT object)

Usage

decode_jwt(token, ...)

## S3 method for class 'AzureToken'
decode_jwt(token, type = c("access", "id"), ...)

## S3 method for class 'Token'
decode_jwt(token, type = c("access", "id"), ...)

## S3 method for class 'character'
decode_jwt(token, ...)

extract_jwt(token, ...)

## S3 method for class 'AzureToken'
extract_jwt(token, type = c("access", "id"), ...)

## S3 method for class 'Token'
extract_jwt(token, type = c("access", "id"), ...)

## S3 method for class 'character'
extract_jwt(token, ...)

Arguments

token

A token object. This can be an object of class AzureToken, of class httr::Token, or a character string containing the encoded token.

...

Other arguments passed to methods.

type

For the AzureToken and httr::Token methods, the token to decode/retrieve: either the access token or ID token.

Details

An OAuth token is a JSON Web Token, which is a set of base64URL-encoded JSON objects containing the token credentials along with an optional (opaque) verification signature. decode_jwt decodes the credentials into an R object so they can be viewed. extract_jwt extracts the credentials from an R object of class AzureToken or httr::Token.

Note that decode_jwt does not touch the token signature or attempt to verify the credentials. You should not rely on the decoded information without verifying it independently. Passing the token itself to Azure is safe, as Azure will carry out its own verification procedure.

Value

For extract_jwt, the character string containing the encoded token, suitable for including in a HTTP query. For decode_jwt, a list containing up to 3 components: header, payload and signature.

See Also

jwt.io, the main JWT informational site

jwt.ms, Microsoft site to decode and explain JWTs

JWT Wikipedia entry