Skip to content
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.

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

Docs: adds allow sign-out URL step to Cognito #1138

Merged
merged 7 commits into from
Jan 9, 2024

Conversation

ZPain8464
Copy link
Contributor

@ZPain8464 ZPain8464 commented Jan 5, 2024

Fixes #1134

@ZPain8464 ZPain8464 requested a review from a team as a code owner January 5, 2024 20:28
@ZPain8464 ZPain8464 requested review from cmo-pomerium and removed request for a team January 5, 2024 20:28
Copy link

netlify bot commented Jan 5, 2024

Deploy Preview for pomerium-docs ready!

Name Link
🔨 Latest commit 709c7ff
🔍 Latest deploy log https://app.netlify.com/sites/pomerium-docs/deploys/659da33c806d240008f944cc
😎 Deploy Preview https://deploy-preview-1138--pomerium-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.


Add the special Pomerium sign-out URL to Cognito's **Allowed sign-out URLs** list:

`https://{AUTHENTICATE_DOMAIN}/.pomerium/signed-out`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this should really be signed_out, with an underscore rather than a hyphen.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@kenjenkins were you able to confirm that signed_out is correct?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's signed_out in the handler endpoint code here: https://github.com/pomerium/pomerium/blob/c84a251c933dd674211d0a96605e56abcb63fde1/authenticate/handlers.go#L91.

Denis has updated it in in his pending changelog PR as well: pomerium/pomerium@4dd8859.

@@ -85,6 +85,14 @@ If you need to make changes after creating your pool, be aware that some setting

You can choose whether to use your own **Domain Name**, or use an AWS-provided one. The AWS-provided domain names are in the format `https://${DOMAIN-PREFIX}.auth.${AWS-REGION}.amazoncognito.com`

### Configure allowed sign-out URLs
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, one other question: would it make more sense for this to be included in the table with the other client settings (in step 3)? It seems similar to the "Callback URL(s)" setting. (Note: I haven't actually seen the Cognito settings page, so I don't actually know what order these settings appear in there.)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@kenjenkins I thought that would've been a good place for the URL as well, but like you I haven't been able to see the settings page. I referenced @wasaga 's screenshot in https://github.com/pomerium/pomerium-zero/issues/1385. I think this would be the cleaner option, though.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I created my own AWS account and tried to go through the process of setting up a user pool in Cognito. Here's a screenshot from what I think is the relevant settings page:

Screen Shot 2024-01-08 at 1 48 25 PM

Based on that screenshot, I think it would make sense to put 'Allowed sign-out URLs' right after the 'Allowed callback URLs' row (line 78 above).

It looks like some of the other settings have been renamed ('OAuth 2.0 grant types' instead of 'Allowed OAuth Flows' and 'OpenID Connect scopes' instead of 'Allowed OAuth Scopes'). I'll file a separate issue for that.

@ZPain8464
Copy link
Contributor Author

@kenjenkins I'm aware there is some inconsistency with our example URLs in this guide. We can address that in the Cognito refresh ticket. For now, I just want to add this documentation for v0.25.

@ZPain8464 ZPain8464 merged commit ca70813 into main Jan 9, 2024
6 checks passed
@ZPain8464 ZPain8464 deleted the zpain/cognito-signout-url branch January 9, 2024 20:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs: Update Cognito guide for v0.25
2 participants