 | OAuth |
Core OAuth/OIDC Client Implementation. This instance does not rely on any upstream or realm settings to function. For an upstream-backed OAuth client, use OAuthClient instead.
Inheritance HierarchyNamespace: SanteDB.Client.OAuth
Assembly: SanteDB.Client (in SanteDB.Client.dll) Version: 3.0.2081-alpha+027e4605b77f83de5445cbcd55717223932d2452
SyntaxThe OAuthClientCore type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | OAuthClientCore | DI constructor |
Properties| Name | Description | |
|---|---|---|
 | ClientId | The ClientId of the application. |
 | CryptoRNG | Gets or sets the configured random number generator |
| DiscoveryDocument | Gets or sets the discover document fetched from the server |
| RestClientFactory | Gets the IRestClientFactory service which is injected into this service |
| TokenHandler | Gets the token handler |
| TokenValidationParameters | Gets or sets the token validation parameters |
| Tracer | Gets the tracer to use for logging |
Methods| Name | Description | |
|---|---|---|
| AuthenticateApp | Create an authenticated IClaimsPrincipal using a client credential |
| AuthenticateUser | Authenticate a user using the username and password |
| ChallengeAuthenticateUser | Perform a x_challenge authentication request against the server |
 | CreatePrincipalFromResponse | Create a principal from the response |
| Dispose | Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. |
| Dispose(Boolean) | Releases the unmanaged resources used by the OAuthClientCore and optionally releases the managed resources |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| ExecuteWithRetryT | Executes func with retry specified in GetRetryWaitTimes, sleeping the thread in between. |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object) |
| GetDiscoveryDocument | Get the OpenIdConnectDiscoveryDocument from the remote OAUTH server |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetJsonWebKeySet | Get the JWKS information from the server |
| GetNameClaimType | Retrieves the claim type that is used for name validation in the TokenValidationParameters. |
| GetNonce | Gets a nonce value that is generated from the CSRNG in .NET and conforms to the OIDC specification. |
| GetPrincipal | Gets a IClaimsPrincipal using the request provided |
| GetRestClient | Gets the rest client from the factory for the auth provider (oauth) |
| GetRetryWaitTimes | Gets an array of wait times (in milliseconds) to wait during a retry operation. The size of the returned array denotes how many times to retry. This is used by ExecuteWithRetryT(FuncT, FuncException, Boolean). |
| GetToken | Send the request to the OAUTH server and return the OAuthTokenResponse |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| MapClaims | Map claims from the tokenValidationResult into claims |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| Refresh | Issues a refresh token request to the OAUTH server |
| SetTokenValidationParameters | Set the token validation parameter to be used |
| SetupRestClientForDiscoveryRequest | Setup the restClient for a discovery endpoint request |
| SetupRestClientForJwksRequest | Setup the restClient for a JWKS fetch request |
| SetupRestClientForTokenRequest | Setup the restClient for a token request |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
Fields| Name | Description | |
|---|---|---|
 | _OverrideDiscoveryDocumentUrls | Override discovery document urls |
| _RetryTimes | The retry times that are cached from GetRetryWaitTimes. |
 | ADHOC_DISCOVERY_DOC_KEY | |
| ADHOC_JKWS_DOC_KEY | |
 | APP_SETTING_OVERRIDE_OIDC | When used in the configuration settings - override the endpoints for oauth |
Extension Methods| Name | Description | |
|---|---|---|
 | ConvertTReturn |
The purpose of this method is to convert object me to TReturn. Why?
Because if you have an instance of Act that actually needs to be a SubstanceAdministration we can't just cast
so we have to copy.
(Defined by ExtensionMethods) |
| WithControl |
With control parameter is used as a wrapper for _ parameters
(Defined by QueryFilterExtensions) |
See Also