The type of authentication to use when connecting to remote services.

Syntax

Connect-FHIR -AuthScheme string

Possible Values

None, Basic, GenericOAuth, GenericOAuthClient, AzureAD, AzureMSI, AzureServicePrincipal, AwsRootKeys, AwsEC2Roles, AwsIAMRoles, OAuth, OAuthJWT, ApiKey

Data Type

cstr

Default Value

"None"

Remarks

General

The following options are generally available to all connections:

• None: Uses no authentication.
• Basic: Uses username and password to perform basic authentication.
• ApiKey: Uses the APIKey for the authentication.
• OAuth: Uses OAuth 2.0, with the specific flow being determined by the GrantType=CODE. The OAuthVersion must be set to determine what version of OAuth is used.
• GenericOAuth: Uses OAuth 2.0, with the specific flow being determined by the GrantType=CODE. The OAuthVersion must be set to determine what version of OAuth is used.
• GenericOAuthClient: Uses OAuth 2.0, with the specific flow being determined by the GrantType=CLIENT. The OAuthVersion must be set to determine what version of OAuth is used.
• OAuthJWT: Set this to perform OAuth authentication with a JWT certificate. Requires the following additional connection properties. [OAuthJWTCert,/OAuthJWTCertType/OAuthJWTCertPassword/OAuthJWTCertSubject/OAuthJWTIssuer/OAuthJWTSubject]
• AzureAD: Set this to perform Azure Active Directory OAuth authentication.
• AzureMSI: Set this to automatically obtain Managed Service Identity credentials when running on an Azure VM.
• AzureServicePrincipal: Set this to authenticate as an Azure Service Principal.
• AwsRootKeys: Set this to use the root user access key and secret. Useful for quickly testing, but production use cases are encouraged to use something with narrowed permissions.
• AwsIAMRoles: Set to use AWS IAM Roles for the connection.
• AwsEC2Roles: Set this to automatically use AWS IAM Roles assigned to the EC2 machine the CData Cmdlets PowerShell Module for FHIR is currently running on.

This is a required parameter.