UserPoolIdentityProviderAppleProps¶
-
class
aws_cdk.aws_cognito.
UserPoolIdentityProviderAppleProps
(*, user_pool, attribute_mapping=None, client_id, key_id, private_key, team_id, scopes=None)¶ Bases:
aws_cdk.aws_cognito.UserPoolIdentityProviderProps
Properties to initialize UserPoolAppleIdentityProvider.
- Parameters
user_pool (
IUserPool
) – The user pool to which this construct provides identities.attribute_mapping (
Optional
[AttributeMapping
]) – Mapping attributes from the identity provider to standard and custom attributes of the user pool. Default: - no attribute mappingclient_id (
str
) – The client id recognized by Apple APIs.key_id (
str
) – The keyId (of the same key, which content has to be later supplied asprivateKey
) for Apple APIs to authenticate the client.private_key (
str
) – The privateKey content for Apple APIs to authenticate the client.team_id (
str
) – The teamId for Apple APIs to authenticate the client.scopes (
Optional
[Sequence
[str
]]) – The list of apple permissions to obtain for getting access to the apple profile. Default: [ name ]
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_cognito as cognito # provider_attribute: cognito.ProviderAttribute # user_pool: cognito.UserPool user_pool_identity_provider_apple_props = cognito.UserPoolIdentityProviderAppleProps( client_id="clientId", key_id="keyId", private_key="privateKey", team_id="teamId", user_pool=user_pool, # the properties below are optional attribute_mapping=cognito.AttributeMapping( address=provider_attribute, birthdate=provider_attribute, custom={ "custom_key": provider_attribute }, email=provider_attribute, family_name=provider_attribute, fullname=provider_attribute, gender=provider_attribute, given_name=provider_attribute, last_update_time=provider_attribute, locale=provider_attribute, middle_name=provider_attribute, nickname=provider_attribute, phone_number=provider_attribute, preferred_username=provider_attribute, profile_page=provider_attribute, profile_picture=provider_attribute, timezone=provider_attribute, website=provider_attribute ), scopes=["scopes"] )
Attributes
-
attribute_mapping
¶ Mapping attributes from the identity provider to standard and custom attributes of the user pool.
- Default
no attribute mapping
- Return type
Optional
[AttributeMapping
]
-
client_id
¶ The client id recognized by Apple APIs.
-
key_id
¶ The keyId (of the same key, which content has to be later supplied as
privateKey
) for Apple APIs to authenticate the client.- Return type
str
-
private_key
¶ The privateKey content for Apple APIs to authenticate the client.
- Return type
str
-
scopes
¶ The list of apple permissions to obtain for getting access to the apple profile.
- Default
[ name ]
- See
https://developer.apple.com/documentation/sign_in_with_apple/clientconfigi/3230955-scope
- Return type
Optional
[List
[str
]]
-
team_id
¶ The teamId for Apple APIs to authenticate the client.
- Return type
str