For the complete documentation index, see llms.txt. This page is also available as Markdown.

ParseToken

Parses the provided OAuth JWT token or Authorization header.

Task version: 1.3.0

Required Frends version: 5.5+

Required .NET version: 6.0

Compatible Agents: Crossplatform

Task Parameters

Name
Description

AuthHeaderOrToken : String

Either the JWT token or the Authorization header value through #trigger.data.httpHeaders["Authorization"].

Default: #trigger.data.httpHeaders["Authorization"] Example: #trigger.data.httpHeaders["Authorization"]

Audience : String

The expected Audiences of the token, e.g. ClientId.

Default: - Example: fIVLouKUZasdYP3tdO9D3dwd6ZNS9Be

Issuer : String

The expected Issuer of the token.

Default: https://xyz.eu.auth0.com/ Example: https://xyz.eu.auth0.com/

ConfigurationSource : ConfigurationSource

The configuration source.

Possible values:

  • WellKnownConfigurationUrl: .well-known configuration.

  • Static: Static.

Default: Static Example: Static

WellKnownConfigurationUrl : String

The URL where the .well-known configuration for the issuer is located.

Default: https://xyz.eu.auth0.com/.well-known/openid-configuration Example: https://xyz.eu.auth0.com/.well-known/openid-configuration

StaticJwksConfiguration : String

Static signing keys to use, can be found in the jwks_uri from the .well-known openid-configurations.

Default: - Example: o80vbR0ZfMhjZWfqwPUGNkcIeUcweFyzB2S2T

Name
Description

SkipIssuerValidation : Boolean

Should the issuer (iss) validation be skipped.

Default: - Example: True

SkipAudienceValidation : Boolean

Should audience (aud) validation be skipped.

Default: - Example: True

SkipLifetimeValidation : Boolean

Should lifetime (exp,nbf) validation be skipped.

Default: - Example: True

DecryptToken : Boolean

Should the Token be decrypted.

Default: - Example: True

🗝DecryptionKey : String

Decryption key, should be in PEM format.

Default: - Example: -----BEGIN RSA PRIVATE KEY-----TheKey-----END RSA PRIVATE KEY-----

Task Result

Name
Description

Id : String

Unique identifier of the security token. Example: 9b3250d8d5ee432

Issuer : String

'issuer' claim { iss, 'value' }. Example: https://frends.com/"

Audiences : String

'audience' claim { aud, 'value' }. Example: "fIVLouKYRihXfYN6tdO9D3dwd6ZNS9Be"

SecurityKeyId : String

SecurityKeys for this instance. Example: gHVXsCt97WM6oGYVm0U0NUaGh7M5MF2CvysUNpShwcU21BAnkKU4Xg

SigningKeyId : String

SecurityKeys for this instance. Example: gHVXsCt97WM6oGYVm0U0NUaGh7M5MF2CvysUNpShwcU21BAnkKU4Xg

ValidFrom : DateTime

Gets the 'value' of the 'notbefore' claim { nbf, 'value' } converted to a DateTime assuming 'value' is seconds since UnixEpoch (UTC 1970-01-01T0:0:0Z). Example: 0001-01-01 0:00:00

ValidTo : DateTime

Gets the 'value' of the 'expiration' claim { exp, 'value' } converted to a DateTime assuming 'value' is seconds since UnixEpoch (UTC 1970-01-01T0:0:0Z). Example: 2018-10-18 20:00:00

Claims : Dictionary<String, Object>

A dictionary of all claims in the token. Example: { {"nickname", "foobar"}, {"name", "Foo Bar"}, {"updated_at", "2018-10-18T10:10:19.4430000Z"}, {"iss", "https://foo.bar/"}, ... }

Task Changelog

Changelog for Task Frends.OAuth.ParseToken.

[1.3.0] - 2025-12-02

Added

  • Support for handling array-type claims in the token, such as "roles": ["editor", "admin"].

[1.2.0] - 2024-08-21

Added

  • Support for new IdentityModel-versions.

[1.1.0] - 2023-12-08

Added

  • New dictionary parameter 'ParseResult.Claims' that contains all claims in the token.

[1.0.1] - 2022-08-04

Changed

  • Using custom result values instead of MS library classes for Frends integrity.

[1.0.0] - 2022-07-01

Added

  • Initial implementation

Last updated

Was this helpful?