Class: AWSCDK::Verifiedpermissions::CfnIdentitySource::OpenIdConnectAccessTokenConfigurationProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::Verifiedpermissions::CfnIdentitySource::OpenIdConnectAccessTokenConfigurationProperty

Defined in:

verifiedpermissions/cfn_identity_source.rb

Overview

The configuration of an OpenID Connect (OIDC) identity source for handling access token claims.

Contains the claim that you want to identify as the principal in an authorization request, and the values of the aud claim, or audiences, that you want to accept.

This data type is part of a OpenIdConnectTokenSelection structure, which is a parameter of CreateIdentitySource .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-verifiedpermissions-identitysource-openidconnectaccesstokenconfiguration.html

Instance Attribute Summary

• #audiences ⇒ Array<String>^? readonly

  The access token aud claim values that you want to accept in your policy store.

• #principal_id_claim ⇒ String^? readonly

  The claim that determines the principal in OIDC access tokens.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(audiences: nil, principal_id_claim: nil) ⇒ OpenIdConnectAccessTokenConfigurationProperty constructor

  A new instance of OpenIdConnectAccessTokenConfigurationProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(audiences: nil, principal_id_claim: nil) ⇒ OpenIdConnectAccessTokenConfigurationProperty

Returns a new instance of OpenIdConnectAccessTokenConfigurationProperty.

Parameters:

• audiences (Array<String>, nil) (defaults to: nil) —

  The access token aud claim values that you want to accept in your policy store.

• principal_id_claim (String, nil) (defaults to: nil) —

  The claim that determines the principal in OIDC access tokens.

# File 'verifiedpermissions/cfn_identity_source.rb', line 762

def initialize(audiences: nil, principal_id_claim: nil)
  @audiences = audiences
  Jsii::Type.check_type(@audiences, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "audiences") unless @audiences.nil?
  @principal_id_claim = principal_id_claim
  Jsii::Type.check_type(@principal_id_claim, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "principalIdClaim") unless @principal_id_claim.nil?
end

Instance Attribute Details

#audiences ⇒ Array<String>^? (readonly)

The access token aud claim values that you want to accept in your policy store.

For example, https://myapp.example.com, https://myapp2.example.com .

Returns:

• (Array<String>, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-verifiedpermissions-identitysource-openidconnectaccesstokenconfiguration.html#cfn-verifiedpermissions-identitysource-openidconnectaccesstokenconfiguration-audiences

# File 'verifiedpermissions/cfn_identity_source.rb', line 775

def audiences
  @audiences
end

#principal_id_claim ⇒ String^? (readonly)

Note:

Default: - "sub"

The claim that determines the principal in OIDC access tokens.

For example, sub .

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-verifiedpermissions-identitysource-openidconnectaccesstokenconfiguration.html#cfn-verifiedpermissions-identitysource-openidconnectaccesstokenconfiguration-principalidclaim

# File 'verifiedpermissions/cfn_identity_source.rb', line 783

def principal_id_claim
  @principal_id_claim
end

Class Method Details

.jsii_properties ⇒ Object

# File 'verifiedpermissions/cfn_identity_source.rb', line 785

def self.jsii_properties
  {
    :audiences => "audiences",
    :principal_id_claim => "principalIdClaim",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'verifiedpermissions/cfn_identity_source.rb', line 792

def to_jsii
  result = {}
  result.merge!({
    "audiences" => @audiences,
    "principalIdClaim" => @principal_id_claim,
  })
  result.compact
end