Class: AWSCDK::Verifiedpermissions::CfnIdentitySource::OpenIdConnectIdentityTokenConfigurationProperty

Inherits:

Jsii::Struct

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

Defined in:

verifiedpermissions/cfn_identity_source.rb

Overview

The configuration of an OpenID Connect (OIDC) identity source for handling identity (ID) 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-openidconnectidentitytokenconfiguration.html

Instance Attribute Summary

• #client_ids ⇒ Array<String>^? readonly

  The ID token audience, or client ID, claim values that you want to accept in your policy store from an OIDC identity provider.

• #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(client_ids: nil, principal_id_claim: nil) ⇒ OpenIdConnectIdentityTokenConfigurationProperty constructor

  A new instance of OpenIdConnectIdentityTokenConfigurationProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(client_ids: nil, principal_id_claim: nil) ⇒ OpenIdConnectIdentityTokenConfigurationProperty

Returns a new instance of OpenIdConnectIdentityTokenConfigurationProperty.

Parameters:

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

  The ID token audience, or client ID, claim values that you want to accept in your policy store from an OIDC identity provider.

• 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 940

def initialize(client_ids: nil, principal_id_claim: nil)
  @client_ids = client_ids
  Jsii::Type.check_type(@client_ids, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "clientIds") unless @client_ids.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

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

The ID token audience, or client ID, claim values that you want to accept in your policy store from an OIDC identity provider.

For example, 1example23456789, 2example10111213 .

Returns:

• (Array<String>, nil)

See Also:

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

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

def client_ids
  @client_ids
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-openidconnectidentitytokenconfiguration.html#cfn-verifiedpermissions-identitysource-openidconnectidentitytokenconfiguration-principalidclaim

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

def principal_id_claim
  @principal_id_claim
end

Class Method Details

.jsii_properties ⇒ Object

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

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

Instance Method Details

#to_jsii ⇒ Object

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

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