On this page:
   34.2    Authentication Callback Scripts 34.4    User Authentication   

34.3Auth: General for APIs

 

The Auth: General for APIs configuration category includes the following configurable options:

  • Anonymous Account Username

  • Allow Anonymous Access

34.3.1Property: Anonymous Account Username

 
Property Name Anonymous Account Username
Property Key
Property Type STRING
Description The account name for the system account to use for anonymous requests.
Applies to Modules
  • CDS-Hooks REST Endpoint
  • FHIR Gateway REST Endpoint
  • FHIR REST Endpoint (DSTU2)
  • FHIR REST Endpoint (R3)
  • FHIR REST Endpoint (R4)
  • Hybrid Providers REST Endpoint
  • JSON Admin API
  • Package Registry Endpoint
  • SMART App Host (Deprecated)
Default Value ANONYMOUS
Example Property
module.[MODULE_ID].config.anonymous.access.account_username = ANONYMOUS

34.3.2Property: Allow Anonymous Access

 
Property Name Allow Anonymous Access
Property Key
Property Type BOOLEAN
Description If enabled, anonymous requests (i.e. requests without credentials) will be allowed to proceed. This means that they will not be blocked by the security manager, and they will instead proceed under the authority of the designated anonymous user. Only roles and permissions that have been assigned to the anonymous user will be granted to these requests. See Anonymous Access for more information.
Applies to Modules
  • CDS-Hooks REST Endpoint
  • FHIR Gateway REST Endpoint
  • FHIR REST Endpoint (DSTU2)
  • FHIR REST Endpoint (R3)
  • FHIR REST Endpoint (R4)
  • Hybrid Providers REST Endpoint
  • JSON Admin API
  • Package Registry Endpoint
  • SMART App Host (Deprecated)
Default Value false
Example Property
module.[MODULE_ID].config.anonymous.access.enabled = false
   34.2    Authentication Callback Scripts 34.4    User Authentication