Skip to content

docs(data-classes): Add more cognito code examples #340

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Mar 15, 2021
Merged

docs(data-classes): Add more cognito code examples #340

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
477c365
docs(data-classes): Add more cognito code examples
michaelbrewer Mar 14, 2021
4c63c6b
feat(data-classes): Provide access to the _data dict
michaelbrewer Mar 15, 2021
55cb42b
Merge branch 'develop' into docs-data-classes-cognito
michaelbrewer Mar 15, 2021
f01f0b4
docs(data-classes): Make note about the wrapped dict
michaelbrewer Mar 15, 2021
4b21442
docs(data-classes): Make references to the AWS Conigto doc examples
michaelbrewer Mar 15, 2021
16dbfab
refactor(data-classes): Rename to
michaelbrewer Mar 15, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
185 changes: 185 additions & 0 deletions docs/utilities/data_classes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -236,6 +236,8 @@ Define Auth Challenge | `data_classes.cognito_user_pool_event.DefineAuthChalleng
Create Auth Challenge | `data_classes.cognito_user_pool_event.CreateAuthChallengeTriggerEvent`
Verify Auth Challenge | `data_classes.cognito_user_pool_event.VerifyAuthChallengeResponseTriggerEvent`

#### Post Confirmation Example

=== "app.py"

```python
Expand All @@ -248,6 +250,189 @@ Verify Auth Challenge | `data_classes.cognito_user_pool_event.VerifyAuthChalleng
do_something_with(user_attributes)
```

#### Define Auth Challenge Example

=== "app.py"

```python
from aws_lambda_powertools.utilities.data_classes.cognito_user_pool_event import DefineAuthChallengeTriggerEvent

def handler(event, context):
_event: DefineAuthChallengeTriggerEvent = DefineAuthChallengeTriggerEvent(event)
if (
len(_event.request.session) == 1
and _event.request.session[0].challenge_name == "SRP_A"
):
_event.response.issue_tokens = False
_event.response.fail_authentication = False
_event.response.challenge_name = "PASSWORD_VERIFIER"
elif (
len(_event.request.session) == 2
and _event.request.session[1].challenge_name == "PASSWORD_VERIFIER"
and _event.request.session[1].challenge_result
):
_event.response.issue_tokens = False
_event.response.fail_authentication = False
_event.response.challenge_name = "CUSTOM_CHALLENGE"
elif (
len(_event.request.session) == 3
and _event.request.session[2].challenge_name == "CUSTOM_CHALLENGE"
and _event.request.session[2].challenge_result
):
_event.response.issue_tokens = True
_event.response.fail_authentication = False
else:
_event.response.issue_tokens = False
_event.response.fail_authentication = True

return event
```
=== "SPR_A response"

```json hl_lines="25-27"
{
"version": "1",
"region": "us-east-1",
"userPoolId": "us-east-1_example",
"userName": "UserName",
"callerContext": {
"awsSdkVersion": "awsSdkVersion",
"clientId": "clientId"
},
"triggerSource": "DefineAuthChallenge_Authentication",
"request": {
"userAttributes": {
"sub": "4A709A36-7D63-4785-829D-4198EF10EBDA",
"email_verified": "true",
"name": "First Last",
"email": "[email protected]"
},
"session": [
{
"challengeName": "SRP_A",
"challengeResult": true
}
]
},
"response": {
"issueTokens": false,
"failAuthentication": false,
"challengeName": "PASSWORD_VERIFIER"
}
}
```
=== "PASSWORD_VERIFIER success response"

```json hl_lines="30-32"
{
"version": "1",
"region": "us-east-1",
"userPoolId": "us-east-1_example",
"userName": "UserName",
"callerContext": {
"awsSdkVersion": "awsSdkVersion",
"clientId": "clientId"
},
"triggerSource": "DefineAuthChallenge_Authentication",
"request": {
"userAttributes": {
"sub": "4A709A36-7D63-4785-829D-4198EF10EBDA",
"email_verified": "true",
"name": "First Last",
"email": "[email protected]"
},
"session": [
{
"challengeName": "SRP_A",
"challengeResult": true
},
{
"challengeName": "PASSWORD_VERIFIER",
"challengeResult": true
}
]
},
"response": {
"issueTokens": false,
"failAuthentication": false,
"challengeName": "CUSTOM_CHALLENGE"
}
}

```
=== "CUSTOM_CHALLENGE success response"

```json hl_lines="34 35"
{
"version": "1",
"region": "us-east-1",
"userPoolId": "us-east-1_example",
"userName": "UserName",
"callerContext": {
"awsSdkVersion": "awsSdkVersion",
"clientId": "clientId"
},
"triggerSource": "DefineAuthChallenge_Authentication",
"request": {
"userAttributes": {
"sub": "4A709A36-7D63-4785-829D-4198EF10EBDA",
"email_verified": "true",
"name": "First Last",
"email": "[email protected]"
},
"session": [
{
"challengeName": "SRP_A",
"challengeResult": true
},
{
"challengeName": "PASSWORD_VERIFIER",
"challengeResult": true
},
{
"challengeName": "CUSTOM_CHALLENGE",
"challengeResult": true
}
]
},
"response": {
"issueTokens": true,
"failAuthentication": false
}
}
```

#### Create Auth Challenge Example

=== "app.py"

```python
from aws_lambda_powertools.utilities.data_classes.cognito_user_pool_event import CreateAuthChallengeTriggerEvent

def handler(event, context):
_event: CreateAuthChallengeTriggerEvent = CreateAuthChallengeTriggerEvent(event)
if _event.request.challenge_name == "CUSTOM_CHALLENGE":
_event.response.public_challenge_parameters = {"captchaUrl": "url/123.jpg"}
_event.response.private_challenge_parameters = {"answer": "5"}
_event.response.challenge_metadata = "CAPTCHA_CHALLENGE"
return event
```

#### Verify Auth Challenge Response Example

=== "app.py"

```python
from aws_lambda_powertools.utilities.data_classes.cognito_user_pool_event import VerifyAuthChallengeResponseTriggerEvent

def handler(event, context):
_event: VerifyAuthChallengeResponseTriggerEvent = VerifyAuthChallengeResponseTriggerEvent(event)
_event.response.answer_correct = (
_event.request.private_challenge_parameters.get("answer") == _event.request.challenge_answer
)
return event
```

### Connect Contact Flow

=== "app.py"
Expand Down