Skip to content

IdentityProviderConfiguration

Used by
Source code in docs_src/capo_healthlake/types/identity_provider_configuration.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
class IdentityProviderConfiguration(TypedDict, closed=True):
    authorization_strategy: (
        "capo_healthlake.types.authorization_strategy.AuthorizationStrategy"
    )
    """<p>The authorization strategy selected when the HealthLake data store is created.</p> <note> <p>HealthLake provides support for both SMART on FHIR V1 and V2 as described below.</p> <ul> <li> <p> <code>SMART_ON_FHIR_V1</code> – Support for only SMART on FHIR V1, which includes <code>read</code> (read/search) and <code>write</code> (create/update/delete) permissions.</p> </li> <li> <p> <code>SMART_ON_FHIR</code> – Support for both SMART on FHIR V1 and V2, which includes <code>create</code>, <code>read</code>, <code>update</code>, <code>delete</code>, and <code>search</code> permissions.</p> </li> <li> <p> <code>Amazon Web Services_AUTH</code> – The default HealthLake authorization strategy; not affiliated with SMART on FHIR.</p> </li> </ul> </note>"""
    fine_grained_authorization_enabled: (
        "capo_healthlake.types.health_lake_boolean.HealthLakeBoolean"
    )
    """<p>The parameter to enable SMART on FHIR fine-grained authorization for the data store.</p>"""
    metadata: NotRequired[
        "capo_healthlake.types.configuration_metadata.ConfigurationMetadata"
    ]
    """<p>The JSON metadata elements to use in your identity provider configuration. Required elements are listed based on the launch specification of the SMART application. For more information on all possible elements, see <a href="https://build.fhir.org/ig/HL7/smart-app-launch/conformance.html#metadata">Metadata</a> in SMART's App Launch specification.</p> <p> <code>authorization_endpoint</code>: The URL to the OAuth2 authorization endpoint.</p> <p> <code>grant_types_supported</code>: An array of grant types that are supported at the token endpoint. You must provide at least one grant type option. Valid options are <code>authorization_code</code> and <code>client_credentials</code>.</p> <p> <code>token_endpoint</code>: The URL to the OAuth2 token endpoint.</p> <p> <code>capabilities</code>: An array of strings of the SMART capabilities that the authorization server supports.</p> <p> <code>code_challenge_methods_supported</code>: An array of strings of supported PKCE code challenge methods. You must include the <code>S256</code> method in the array of PKCE code challenge methods.</p>"""
    idp_lambda_arn: NotRequired["capo_healthlake.types.lambda_arn.LambdaArn"]
    """<p>The Amazon Resource Name (ARN) of the Lambda function to use to decode the access token created by the authorization server.</p>"""

authorization_strategy instance-attribute 

authorization_strategy: AuthorizationStrategy

The authorization strategy selected when the HealthLake data store is created.

HealthLake provides support for both SMART on FHIR V1 and V2 as described below.

  • SMART_ON_FHIR_V1 – Support for only SMART on FHIR V1, which includes read (read/search) and write (create/update/delete) permissions.

  • SMART_ON_FHIR – Support for both SMART on FHIR V1 and V2, which includes create, read, update, delete, and search permissions.

  • Amazon Web Services_AUTH – The default HealthLake authorization strategy; not affiliated with SMART on FHIR.

fine_grained_authorization_enabled instance-attribute 

fine_grained_authorization_enabled: HealthLakeBoolean

The parameter to enable SMART on FHIR fine-grained authorization for the data store.

idp_lambda_arn instance-attribute 

idp_lambda_arn: NotRequired[LambdaArn]

The Amazon Resource Name (ARN) of the Lambda function to use to decode the access token created by the authorization server.

metadata instance-attribute 

metadata: NotRequired[ConfigurationMetadata]

The JSON metadata elements to use in your identity provider configuration. Required elements are listed based on the launch specification of the SMART application. For more information on all possible elements, see Metadata in SMART's App Launch specification.

authorization_endpoint: The URL to the OAuth2 authorization endpoint.

grant_types_supported: An array of grant types that are supported at the token endpoint. You must provide at least one grant type option. Valid options are authorization_code and client_credentials.

token_endpoint: The URL to the OAuth2 token endpoint.

capabilities: An array of strings of the SMART capabilities that the authorization server supports.

code_challenge_methods_supported: An array of strings of supported PKCE code challenge methods. You must include the S256 method in the array of PKCE code challenge methods.