Skip to main content

HS.BulkFHIR.ClientAuth.XAPIKey.Adapter

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

Method Inventory

Parameters

parameter IsOAuth = 0;
Inherited description: Whether the adapter uses OAuth.
parameter archeType = client-auth-x-api-key;
Inherited description: This property describes the overarching type of the adapter & its subclasses, so that they may be understood as belonging to the same group exhibiting fundamentally similar behaviors or serving similar purpose. Used when generating the metadata (GUISettings) for all adapters & config classes so the UI may be able to identify the archeType of adapter it's dealing with, without knowing its full inheritance chain (e.g. all pureFHIR fetch adapter & their subclasses will have the same archeType, all BulkFHIR fetch adapter & subclasses will have same archeType, etc.) and the UI can enforce archeType specific behavior across otherwise indistinguishable adapters & their configs.
parameter configClass = HS.BulkFHIR.ClientAuth.XAPIKey.Config;

Methods

classmethod GetAuthEnabledRestClient(pSession As HS.BulkFHIR.Session = "", pBFCconfig As HS.BulkFHIR.API.Data.Config = "", pClientAuthConfig As HS.BulkFHIR.ClientAuth.XAPIKey.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. simply add x-api-key headers using configured Credentials

Inherited Members

Inherited Methods

FeedbackOpens in a new tab