Powered by Smile CDR v2025.02.PRE-04 (build e75afbc13c)

Showing documentation for 2024.08.R01

On this page:

49.5 Auth: General for APIs 49.7 Auth: HTTP Basic

49.6.1User Authentication

The User Authentication configuration category includes the following configurable options:

Anonymous Account Username
Allow Anonymous Access
SAML Authentication Enabled

49.6.2Property: 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 EasyShare SHL Endpoint (Public) FHIR Gateway REST Endpoint FHIR REST Endpoint (All FHIR Versions) FHIR REST Endpoint (DSTU2 - Deprecated) FHIR REST Endpoint (R3 - Deprecated) FHIR REST Endpoint (R4 - Deprecated) FHIRWeb Console HL7 v2.x Listening Endpoint Hybrid Providers REST Endpoint JSON Admin API MDM UI Package Registry Endpoint Payer to Payer
Default Value	`ANONYMOUS`
Example Property	`module.[MODULE_ID].config.anonymous.access.account_username = ANONYMOUS`

49.6.3Property: 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 EasyShare SHL Endpoint (Public) FHIR Gateway REST Endpoint FHIR REST Endpoint (All FHIR Versions) FHIR REST Endpoint (DSTU2 - Deprecated) FHIR REST Endpoint (R3 - Deprecated) FHIR REST Endpoint (R4 - Deprecated) FHIRWeb Console HL7 v2.x Listening Endpoint Hybrid Providers REST Endpoint JSON Admin API MDM UI Package Registry Endpoint Payer to Payer
Default Value	`false`
Example Property	`module.[MODULE_ID].config.anonymous.access.enabled = false`

49.6.4Property: SAML Authentication Enabled

Property Name	SAML Authentication Enabled
Property Key
Property Type	BOOLEAN
Description	If enabled, this server will support authentication using SAML. See SAML Inbound Security for more information.
Applies to Modules	EasyShare SHL Endpoint (Admin) FHIRWeb Console SMART Outbound Security
Default Value	`false`
Example Property	`module.[MODULE_ID].config.saml.enabled = false`

49.5 Auth: General for APIs 49.7 Auth: HTTP Basic