Documentation

Mistake on this page? Email us

OidcRequest

Hierarchy

Index

Properties

authorizationEndpoint

authorizationEndpoint: string

URL of the OAuth 2.0 authorization endpoint.

autoEnrollment

autoEnrollment: boolean

For future use.

claimMapping

Mapping for non-standard OIDC claim names.

clientId

clientId: string

Client ID needed to authenticate and gain access to identity provider's API.

clientSecret

clientSecret: string

Client secret needed to authenticate and gain access to identity provider's API.

endSessionEndpoint

endSessionEndpoint: string

URL of the provider's end session endpoint.

id

id: string

The unique identifier of the entity

issuer

issuer: string

Issuer of the identity provider.

jwksUri

jwksUri: string

URL of the provider's JSON web key set document.

keys

Represents provider's public key and key ID used to sign ID tokens. PEM-encoded.

redirectUri

redirectUri: string

The URI needed to authenticate and gain access to identity provider's API. Leave this empty to use the default redirect URI.

revocationEndpoint

revocationEndpoint: string

URL of the provider's token revocation endpoint.

scopes

scopes: string

Space-separated list of scopes sent in the authentication request. When not configured otherwise, the default scopes are 'openid profile email'.

example

openid email

tokenEndpoint

tokenEndpoint: string

URL of the OAuth 2.0 authorization endpoint.

tokenRequestMode

tokenRequestMode: OidcRequestTokenMode

One way to obtain the access token. Since the request results in the transmission of clear-text credentials, the client must use the POST mode.

tokenResponsePath

tokenResponsePath: string

Path to the standard data in the token response. Levels in the JSON structure must be separated by '.' (dot) characters.

example

oidc.data

userinfoEndpoint

userinfoEndpoint: string

URL of the OAuth 2.0 UserInfo endpoint.