Class: Aws::HealthLake::Types::IdentityProviderConfiguration

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-healthlake/lib/aws-sdk-healthlake/types.rb

Overview

The identity provider configuration that you gave when the data store was created.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#authorization_strategy ⇒ String

The authorization strategy that you selected when you created the data store.

Returns:

  • (String) 


482
483
484
485
486
487
488
489
 
# File 'gems/aws-sdk-healthlake/lib/aws-sdk-healthlake/types.rb', line 482

class IdentityProviderConfiguration < Struct.new(
  :authorization_strategy,
  :fine_grained_authorization_enabled,
  :metadata,
  :idp_lambda_arn)
  SENSITIVE = []
  include Aws::Structure
end

#fine_grained_authorization_enabled ⇒ Boolean

If you enabled fine-grained authorization when you created the data store.

Returns:

  • (Boolean) 


482
483
484
485
486
487
488
489
 
# File 'gems/aws-sdk-healthlake/lib/aws-sdk-healthlake/types.rb', line 482

class IdentityProviderConfiguration < Struct.new(
  :authorization_strategy,
  :fine_grained_authorization_enabled,
  :metadata,
  :idp_lambda_arn)
  SENSITIVE = []
  include Aws::Structure
end

#idp_lambda_arn ⇒ String

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

Returns:

  • (String) 


482
483
484
485
486
487
488
489
 
# File 'gems/aws-sdk-healthlake/lib/aws-sdk-healthlake/types.rb', line 482

class IdentityProviderConfiguration < Struct.new(
  :authorization_strategy,
  :fine_grained_authorization_enabled,
  :metadata,
  :idp_lambda_arn)
  SENSITIVE = []
  include Aws::Structure
end

#metadata ⇒ String

The JSON metadata elements that you want 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.

Returns:

  • (String) 


482
483
484
485
486
487
488
489
 
# File 'gems/aws-sdk-healthlake/lib/aws-sdk-healthlake/types.rb', line 482

class IdentityProviderConfiguration < Struct.new(
  :authorization_strategy,
  :fine_grained_authorization_enabled,
  :metadata,
  :idp_lambda_arn)
  SENSITIVE = []
  include Aws::Structure
end