OAuth2ClientConfiguration

The configuration for an OAuth2Client.

This defines the basic information necessary for interacting with an OAuth2 authorization server.

In languages with support for namespacing, this type should be contained within the OAuth2Client namespace.

Index

Constructors

• constructor

Properties

• authentication
• baseURL
• clientId
• discoveryURL
• scopes

Constructors

constructor

• new OAuth2ClientConfiguration(__namedParameters: { authentication?: OAuth2ClientAuthenticationType; baseURL: URL; clientId: String; discoveryURL?: URL; scopes: String }): OAuth2ClientConfiguration

• Initializer for constructing an OAuth2Client.

  ---

  Parameters

  • __namedParameters: { authentication?: OAuth2ClientAuthenticationType; baseURL: URL; clientId: String; discoveryURL?: URL; scopes: String }

  • optionalauthentication: OAuth2ClientAuthenticationType

  • baseURL: URL

  • clientId: String

  • optionaldiscoveryURL: URL = undefined

  • scopes: String

  Returns OAuth2ClientConfiguration

Properties

readonlyauthentication

authentication: OAuth2ClientAuthenticationType

The type of authentication this client will perform when interacting with the authorization server.

Defaults to: OAuth2Client/AuthenticationNone

readonlybaseURL

baseURL: URL

The base URL for interactions with this OAuth2 server.

readonlyclientId

clientId: String

The unique client ID representing this OAuth2Client.

readonlydiscoveryURL

discoveryURL: URL

The discovery URL used to retrieve the OpenIdConfiguration for this client.

readonlyscopes

scopes: String

The list of OAuth2 scopes requested for this client.