HS.BulkFHIR.Auth.OAuth.Adapter

Inherited description: Whether the adapter uses OAuth access tokens. Used in conjunction with the storage adapter to set the requireAccessToken setting in a status request.

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.

authenticates %request, and will return a %response of error unless operation is permitted the flag pContinue informs caller code whether if API handling should continue or not The optional @Input "pAllowedAud" only applies when %request comes with an access token, where the audience will be checked whether it matches the request URL. "pAllowedAud", when defined, will allow the access token to pass the auth check if it matches the "pAllowedAud" input. Used for case where one endpoint is required to accept access token meant for another endpoint (e.g. BulkFHIR file endpoint has to accept a token with the kick-off audience)

Use the access token information to authorize the current interaction. metadata request does NOT come through this method. Such authorization is not needed for metadata.

given list of HS.BulkFHIR.Auth.OAuth.ClientConfig objects, will return a DynamicArray of all the undefined clients that needs to be created

Override of API method.
Return a %DynamicObject of selected access token fields.
@Returns a %DynamicObject representing information about the access token.

@API.Overridable
Return a %DynamicObject representing the full access token information.
@Input pBFCconfig Full BFC configuration object in effect for the current BFC session.
@Input pTokenString Encoded string representation of an access token provided on the current request to the BFC.
@Returns a %DynamicObject representing the full access token information.

@API.Overridable
This method presents the token string to the introspection endpoint for the server that granted this token.

The server returns a JSON object with information about the token. RFC 7662 "OAuth 2.0 Token Introspection" Section 2.2 (https://datatracker.ietf.org/doc/html/rfc7662#section-2.2) describes the expected contents of the returned JSON object. RFC 7662 lists "scope" as OPTIONAL. However, for FHIRServer processing, it is REQUIRED.

This method checks the JSON object to verify that the token is active (well-formed and not expired), and returns it as ByRef variable pJWTObj.

By the time this method returns, pJWTObj MUST hold the token scopes in the 'scope' property, as a space-delimited string. If the tokens being handled by this class are expected to hold scopes in an alternate property and/or in an alternate format, you may need to override this method to ensure that the scopes are moved and/or reformatted into the 'scope' property. The default implementation of this method handles only one common alternate scenario, where the token object scopes are found in property 'scp', either as a JSON array or a space-delimited string. Other alternate scenarios must be handled via override of this method.

If the server that granted the token does not host an introspection endpoint, then you must override this method to derive/obtain a JSON object that holds information about the access token, with the required properties described above.

@Input pOAuthClient OAuth 2.0 client name as defined in ISC OAuth 2.0 Client definitions.
@Input pTokenString OAuth 2.0 access token string.
@Output pJWTObj JSON object that holds information about the token.
@Return %Status return value.

Inherited description: @API.Overridable
Called when the BFC is first configured and again if that configuration is changed, this method may be used to do any implementation-specific setup.

Override of API method.
@Returns a %DynamicObject representing the .well-known/smart-configuration for the BFC OAuth server.