HS.BulkFHIR.OAuth2Installer
class HS.BulkFHIR.OAuth2Installer
Utility for setting up an IRIS OAuth 2.0 authorization server in the local IRIS instance, specifically for handling SMART Backend Services Authorization for the Bulk FHIR Coordinator.Method Inventory
Parameters
parameter OAuthIssuerServiceName = OAuth2.Issuer;
HTTP Service Registry entry name used throughout this utility.
parameter OAuthSSLConfigName = OAuth2.SSLConfig;
SSL Configuration Name used throughout this utility.
Methods
classmethod ConfigureAuthServer(Output pIssuerURL As %String, pHost As %String, pPort As %String, pPathPrefix As %String, pForceDelete As %Boolean = 0) as %Status
@API.Method
Configure an IRIS OAuth 2.0 authorization server in the local IRIS instance specifically for handling SMART Backend Services Authorization for Bulk FHIR Coordinator endpoints. This method does not overlay an existing server with new definitions. When a server already exists, this method either deletes the server before proceeding, or aborts, depending on the pForceDelete input parameter.
Input:
- pHost : Local secure web server host name.
- pPort : Local secure web server port.
- pPrefix : Local secure web server path prefix.
- pForceDelete: 0 = abort and return fail if an existing OAuth server is found, 1 = delete existing OAuth server and its clients before re-creating.
Configure an IRIS OAuth 2.0 authorization server in the local IRIS instance specifically for handling SMART Backend Services Authorization for Bulk FHIR Coordinator endpoints. This method does not overlay an existing server with new definitions. When a server already exists, this method either deletes the server before proceeding, or aborts, depending on the pForceDelete input parameter.
Input:
- pHost : Local secure web server host name.
- pPort : Local secure web server port.
- pPrefix : Local secure web server path prefix.
- pForceDelete: 0 = abort and return fail if an existing OAuth server is found, 1 = delete existing OAuth server and its clients before re-creating.
SetupOAuthServer configures an IRIS OAuth 2.0 authorization server in the local
IRIS instance specifically for SMART Backend Services Authorization and creates
a Service Registry entry that points to the OAuth server issuer endpoint. This
method depends on class parameters OAuthSSLConfigName and OAuthIssuerServiceName
for the values of those two items.
Prerequisites for using this method:
- A web server and SSL is already configured for the current IRIS instance.
- Installer Wizard Secure Communications definitions are already present and active.
- Must be invoked in a Foundation namespace that is targeted for installing Bulk FHIR Coordinator configurations.
Input:
- pForceDelete: 0 = abort and return fail if an existing OAuth server is found, 1 = delete existing OAuth server and its clients before re-creating.
- pVerbose: 0 = do not display method outcome text, 1 = display method outcome text.
Prerequisites for using this method:
- A web server and SSL is already configured for the current IRIS instance.
- Installer Wizard Secure Communications definitions are already present and active.
- Must be invoked in a Foundation namespace that is targeted for installing Bulk FHIR Coordinator configurations.
Input:
- pForceDelete: 0 = abort and return fail if an existing OAuth server is found, 1 = delete existing OAuth server and its clients before re-creating.
- pVerbose: 0 = do not display method outcome text, 1 = display method outcome text.
SetupServiceEntry creates a Service Registry entry in the current namespace
to point to the issuer endpoint for the OAuth server in the current IRIS
instance. This method depends on class parameters OAuthSSLConfigName and
OAuthIssuerServiceName for the values of those two items.
Prerequisites for using this method:
- A web server and SSL is already configured for the current IRIS instance.
- Installer Wizard Secure Communications definitions are already present and active.
- Must be invoked in a Foundation namespace that is targeted for installing Bulk FHIR Coordinator configurations.
Input:
- pVerbose: 0 = do not display method outcome text, 1 = display method outcome text.
Prerequisites for using this method:
- A web server and SSL is already configured for the current IRIS instance.
- Installer Wizard Secure Communications definitions are already present and active.
- Must be invoked in a Foundation namespace that is targeted for installing Bulk FHIR Coordinator configurations.
Input:
- pVerbose: 0 = do not display method outcome text, 1 = display method outcome text.