Skip to main content

HS.BulkFHIR.ClientAuth.OAuth.Config

class HS.BulkFHIR.ClientAuth.OAuth.Config extends HS.BulkFHIR.ClientAuth.ConfigBase

Property Inventory

Method Inventory

Parameters

parameter SETTINGS = ssl_configuration:::SSL Configuration,oauth_issuer_url:OAuth:Authorization:OAuth Issuer URL,client_name:OAuth:Authorization,grant_type:OAuth:Authorization,fetch_token_scopes:OAuth:Authorization,fetch_token_credential_id:OAuth:Authorization:Fetch Token Credential ID;
config for UI: {property}:::{property rename}

Properties

property client_name as %String) [ Required ];
Name to identify the Bulk FHIR Coordinator with the FHIR endpoint's OAuth server
Property methods: client_nameDisplayToLogical(), client_nameGet(), client_nameIsValid(), client_nameLogicalToDisplay(), client_nameLogicalToOdbc(), client_nameNormalize(), client_nameSet()
property fetch_token_credential_id as %String;
The Interoperability Credential ID to use in authenticating with the FHIR endpoint's OAuth server for grant type "password"
Property methods: fetch_token_credential_idDisplayToLogical(), fetch_token_credential_idGet(), fetch_token_credential_idIsValid(), fetch_token_credential_idLogicalToDisplay(), fetch_token_credential_idLogicalToOdbc(), fetch_token_credential_idNormalize(), fetch_token_credential_idSet()
property fetch_token_scopes as list of %String);
Comma-delimited list of OAuth scopes to specify when obtaining an access token from the FHIR endpoint's OAuth server. Applies only when there was no access token in the request to the Bulk FHIR Coordinator.
Property methods: fetch_token_scopesBuildValueArray(), fetch_token_scopesCollectionToDisplay(), fetch_token_scopesCollectionToOdbc(), fetch_token_scopesDisplayToCollection(), fetch_token_scopesDisplayToLogical(), fetch_token_scopesGet(), fetch_token_scopesGetObject(), fetch_token_scopesGetObjectId(), fetch_token_scopesGetSwizzled(), fetch_token_scopesIsValid(), fetch_token_scopesLogicalToDisplay(), fetch_token_scopesLogicalToOdbc(), fetch_token_scopesNormalize(), fetch_token_scopesOdbcToCollection(), fetch_token_scopesSet(), fetch_token_scopesSetObject(), fetch_token_scopesSetObjectId()
property grant_type as %String (VALUELIST = ",client_credentials,password") [ Required ];
OAuth grant type to use when obtaining an access token from the FHIR endpoint's OAuth server.
Property methods: grant_typeDisplayToLogical(), grant_typeGet(), grant_typeIsValid(), grant_typeLogicalToDisplay(), grant_typeLogicalToOdbc(), grant_typeNormalize(), grant_typeSet()
property oauth_issuer_url as %String) [ Required ];
Issuer url for the FHIR endpoint's OAuth server.
Property methods: oauth_issuer_urlDisplayToLogical(), oauth_issuer_urlGet(), oauth_issuer_urlIsValid(), oauth_issuer_urlLogicalToDisplay(), oauth_issuer_urlLogicalToOdbc(), oauth_issuer_urlNormalize(), oauth_issuer_urlSet()

Methods

method %OnValidateObject() as %Status
validate & throw specific errors

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab