 | OAuth |
An implementation of the OAuth client
Inheritance HierarchyNamespace: SanteDB.Client.OAuth
Assembly: SanteDB.Client (in SanteDB.Client.dll) Version: 3.0.2081-alpha+027e4605b77f83de5445cbcd55717223932d2452
SyntaxThe OAuthClient type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | OAuthClient | DI constructor |
Properties| Name | Description | |
|---|---|---|
 | ClientId |
The ClientId of the application.
(Inherited from OAuthClientCore) |
 | CryptoRNG |
Gets or sets the configured random number generator
(Inherited from OAuthClientCore) |
| DiscoveryDocument |
Gets or sets the discover document fetched from the server
(Inherited from OAuthClientCore) |
| RestClientFactory |
Gets the IRestClientFactory service which is injected into this service
(Inherited from OAuthClientCore) |
| TokenHandler |
Gets the token handler
(Inherited from OAuthClientCore) |
| TokenValidationParameters |
Gets or sets the token validation parameters
(Inherited from OAuthClientCore) |
| Tracer |
Gets the tracer to use for logging
(Inherited from OAuthClientCore) |
Methods| Name | Description | |
|---|---|---|
| AuthenticateApp |
Create an authenticated IClaimsPrincipal using a client credential
(Inherited from OAuthClientCore) |
| AuthenticateUser |
Authenticate a user using the username and password (Inherited from OAuthClientCore) |
| ChallengeAuthenticateUser |
Perform a x_challenge authentication request against the server
(Inherited from OAuthClientCore) |
 | CreatePrincipalFromResponse |
Create a principal from the response (Inherited from OAuthClientCore) |
| Dispose | Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from OAuthClientCore) |
| Dispose(Boolean) | (Inherited from OAuthClientCore) |
| 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.
(Inherited from OAuthClientCore) |
| 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
(Inherited from OAuthClientCore) |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetJsonWebKeySet |
Get the JWKS information from the server
(Inherited from OAuthClientCore) |
| GetNameClaimType |
Retrieves the claim type that is used for name validation in the TokenValidationParameters.
(Inherited from OAuthClientCore) |
| GetNonce |
Gets a nonce value that is generated from the CSRNG in .NET and conforms to the OIDC specification.
(Inherited from OAuthClientCore) |
| GetPrincipal |
Gets a IClaimsPrincipal using the request provided
(Inherited from OAuthClientCore) |
| GetRestClient |
Gets the rest client from the factory for the auth provider (oauth)
(Inherited from OAuthClientCore) |
| 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).
(Inherited from OAuthClientCore) |
| GetToken |
Contacts the OAUTH server with request (Overrides OAuthClientCoreGetToken(OAuthTokenRequest, IEnumerableIClaim)) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| MapClaims |
Maps the claims from the tokenValidationResult to the claims (Overrides OAuthClientCoreMapClaims(TokenValidationResult, OAuthTokenResponse, ListIClaim)) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| Refresh |
Issues a refresh token request to the OAUTH server
(Inherited from OAuthClientCore) |
| SetTokenValidationParameters |
Set the token validation parameters based on the configuration
(Overrides OAuthClientCoreSetTokenValidationParameters) |
| SetupRestClientForDiscoveryRequest |
Setup the restClient for a discovery endpoint request
(Inherited from OAuthClientCore) |
| SetupRestClientForJwksRequest |
Setup the restClient for a JWKS fetch request
(Inherited from OAuthClientCore) |
| SetupRestClientForTokenRequest |
Setup this class to send a token request
(Overrides OAuthClientCoreSetupRestClientForTokenRequest(IRestClient, OAuthTokenRequest, IEnumerableIClaim)) |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
| UpstreamRealmChanged | Event handler when the upstream realm has changed |
| UpstreamRealmChanging | handler for when the upstream realm has changed |
Fields| Name | Description | |
|---|---|---|
 | _OverrideDiscoveryDocumentUrls |
Override discovery document urls
(Inherited from OAuthClientCore) |
| _RetryTimes |
The retry times that are cached from GetRetryWaitTimes.
(Inherited from OAuthClientCore) |
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