TsgcHTTP_OAuth2_Server_Provider › Methods

TsgcHTTP_OAuth2_Server_Provider Methods

Public methods grouped by purpose, followed by the full alphabetical list.

Tokens

Name	Description
AddToken	Inserts an externally-issued access/refresh token into the Resource Server token cache so subsequent Bearer-token validations succeed without a round-trip to the external identity provider.
RemoveToken	Revokes a Bearer token currently held in the Resource Server cache, looking it up by the server-side session identifier.
IsOAuth2TokenValid	Validates the Bearer token presented with an inbound request against the Resource Server cache, either by parsing the request headers or by taking the raw token string.
IsPrivateEndpoint	Returns whether a given URL is flagged as private and therefore requires a valid Bearer token / session cookie to be served.

HTTP verbs

Name	Description
Get	Sends an HTTP GET request to a remote URL through the Resource Server OAuth2 pipeline, injecting the Bearer token (and DPoP proof when enabled) that matches the caller's session.
Post	Sends an HTTP POST request to a remote URL through the Resource Server OAuth2 pipeline, injecting the Bearer token (and DPoP proof when enabled) that matches the caller's session.
Put	Sends an HTTP PUT request to a remote URL through the Resource Server OAuth2 pipeline, injecting the Bearer token (and DPoP proof when enabled) that matches the caller's session.
Delete	Sends an HTTP DELETE request to a remote URL through the Resource Server OAuth2 pipeline, injecting the Bearer token (and DPoP proof when enabled) that matches the caller's session.
Patch	Sends an HTTP PATCH request to a remote URL through the Resource Server OAuth2 pipeline, injecting the Bearer token (and DPoP proof when enabled) that matches the caller's session.

Apps

Name	Description
RegisterApp	Registers an OAuth 2.0 client application on the Resource Server and returns its generated credentials.
UnRegisterApp	Removes a previously registered OAuth 2.0 client application from the Resource Server.

Providers

Name	Description
RegisterProvider	Registers an external OAuth 2.0 identity provider (Azure AD, Google, Microsoft, Facebook, GitHub...) so the Resource Server can delegate user sign-in to it.
UnRegisterProvider	Removes a previously registered external identity provider from the Resource Server.
ClearProviders	Removes every external identity provider currently registered in the Resource Server federation list.

Advanced

Name	Description
DoProcessHTTP	Main HTTP pipeline hook that validates the Bearer token on inbound requests, dispatches provider login/callback URLs and enforces protection of private endpoints.

All Methods (alphabetical)

Name	Description
AddToken	Inserts an externally-issued access/refresh token into the Resource Server token cache so subsequent Bearer-token validations succeed without a round-trip to the external identity provider.
ClearProviders	Removes every external identity provider currently registered in the Resource Server federation list.
Delete	Sends an HTTP DELETE request to a remote URL through the Resource Server OAuth2 pipeline, injecting the Bearer token (and DPoP proof when enabled) that matches the caller's session.
DoProcessHTTP	Main HTTP pipeline hook that validates the Bearer token on inbound requests, dispatches provider login/callback URLs and enforces protection of private endpoints.
Get	Sends an HTTP GET request to a remote URL through the Resource Server OAuth2 pipeline, injecting the Bearer token (and DPoP proof when enabled) that matches the caller's session.
IsOAuth2TokenValid	Validates the Bearer token presented with an inbound request against the Resource Server cache, either by parsing the request headers or by taking the raw token string.
IsPrivateEndpoint	Returns whether a given URL is flagged as private and therefore requires a valid Bearer token / session cookie to be served.
Patch	Sends an HTTP PATCH request to a remote URL through the Resource Server OAuth2 pipeline, injecting the Bearer token (and DPoP proof when enabled) that matches the caller's session.
Post	Sends an HTTP POST request to a remote URL through the Resource Server OAuth2 pipeline, injecting the Bearer token (and DPoP proof when enabled) that matches the caller's session.
Put	Sends an HTTP PUT request to a remote URL through the Resource Server OAuth2 pipeline, injecting the Bearer token (and DPoP proof when enabled) that matches the caller's session.
RegisterApp	Registers an OAuth 2.0 client application on the Resource Server and returns its generated credentials.
RegisterProvider	Registers an external OAuth 2.0 identity provider (Azure AD, Google, Microsoft, Facebook, GitHub...) so the Resource Server can delegate user sign-in to it.
RemoveToken	Revokes a Bearer token currently held in the Resource Server cache, looking it up by the server-side session identifier.
UnRegisterApp	Removes a previously registered OAuth 2.0 client application from the Resource Server.
UnRegisterProvider	Removes a previously registered external identity provider from the Resource Server.