Skip to main content

HS.BulkFHIR.ClientAuth.OAuth.Adapter

class HS.BulkFHIR.ClientAuth.OAuth.Adapter extends HS.BulkFHIR.API.ClientAuthAdapter

Method Inventory

Parameters

parameter IsOAuth = 1;
Inherited description: Whether the adapter uses OAuth.
parameter configClass = HS.BulkFHIR.ClientAuth.OAuth.Config;

Methods

classmethod GetAuthEnabledRestClient(pSession As HS.BulkFHIR.Session = "", pBFCconfig As HS.BulkFHIR.API.Data.Config = "", pClientAuthConfig As HS.BulkFHIR.ClientAuth.OAuth.Config, pMaxRequestsPerSec As %Integer = 10, ByRef pHeaders, pAccessTokenConfig As HS.BulkFHIR.Fetch.Util.AccessToken = "", pAdditionalAudienceUrl As %String = "") as HS.BulkFHIR.Fetch.Util.RestClient
One of either @Input pSession or @Input pBFCConfig must be specified. If pAccessTokenConfig is specified & session un-specified, then will derive fetch token from this over using pSession config @Input pAdditionalAudienceUrl a comma-separated string for any additional audiences
classmethod GetFetchScopes(pSession As HS.BulkFHIR.Session, pClientAuthConfig As HS.BulkFHIR.ClientAuth.OAuth.Config) as %String
Utility method for obtaining fetch scopes from a session. First checks session.tokenInfo, then nested client auth config
classmethod GetFetchTokenInfo(pBFCconfig As HS.BulkFHIR.API.Data.Config = "", pClientAuthConfig As HS.BulkFHIR.ClientAuth.OAuth.Config, pSession As HS.BulkFHIR.Session) as %DynamicObject
Utility method for creating a concise object containing the scopes & credentials with which requests for access tokens may be made Used to create instances of HS.BulkFHIR.Session fetchTokenInfo property, for the purpose of utilizing HS.BulkFHIR.Fetch.Util.AccessToken
classmethod InitializeAdapterSpecific(pBFCconfig As HS.BulkFHIR.API.Data.Config, pClientAuthConfig As HS.BulkFHIR.ClientAuth.OAuth.Config, ByRef pServiceRegistryEntry As HS.Registry.Service.HTTP)
called whenever BFC is (re)configured
classmethod PrelimValidateSession(pSession As HS.BulkFHIR.Session, pClientAuthConfig As HS.BulkFHIR.ClientAuth.OAuth.Config, pRequestedResourceTypes)
Preliminary check that list of scopes to be requested do not exceed list of authorized scopes configured in session. @Input pRequestedResourceTypes is a local global where subscript is name of the resource requested (value can be empty string)
classmethod ValidateTypesAndScopes(pScopes As %String, ByRef pRequestedResourceTypes)
Validate that the requested resource types do not exceed what is authorized by the access token scopes.

Inherited Members

Inherited Methods

FeedbackOpens in a new tab