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

doc: Change documentation for new attributes to support OIDC Identity providers #1883

Merged
merged 12 commits into from Feb 1, 2024

Conversation

oarbusi
Copy link
Collaborator

@oarbusi oarbusi commented Jan 30, 2024

Description

Change in docs to add details about new attributes added to federated_settings_identity_provider to support OIDC IdPs

Link to any related issue(s): https://jira.mongodb.org/browse/CLOUDP-220800

Type of change:

  • Bug fix (non-breaking change which fixes an issue). Please, add the "bug" label to the PR.
  • New feature (non-breaking change which adds functionality). Please, add the "enhancement" label to the PR.
  • Breaking change (fix or feature that would cause existing functionality to not work as expected). Please, add the "breaking change" label to the PR.
  • This change requires a documentation update
  • Documentation fix/enhancement

Required Checklist:

  • I have signed the MongoDB CLA
  • I have read the contribution guidelines
  • I have checked that this change does not generate any credentials and that they are NOT accidentally logged anywhere.
  • I have added tests that prove my fix is effective or that my feature works per HashiCorp requirements
  • I have added any necessary documentation (if appropriate)
  • I have run make fmt and formatted my code
  • If changes include deprecations or removals, I defined an isolated PR with a relevant title as it will be used in the auto-generated changelog.
  • If changes include removal or addition of 3rd party GitHub actions, I updated our internal document. Reach out to the APIx Integration slack channel to get access to the internal document.

Further comments

@oarbusi oarbusi changed the title docs: Change documentation for new attributes to support OIDC Identity providers doc: Change documentation for new attributes to support OIDC Identity providers Jan 30, 2024
@oarbusi oarbusi marked this pull request as ready for review January 30, 2024 13:56
@oarbusi oarbusi requested a review from a team as a code owner January 30, 2024 13:56
- HTTP POST
- HTTP REDIRECT
* `response_signature_algorithm` - (Required) Signature algorithm that Federated Authentication uses to encrypt the identity provider signature. Valid values include SHA-1 and SHA-256.
* `response_signature_algorithm` - Signature algorithm that Federated Authentication uses to encrypt the identity provider signature. Valid values include SHA-1 and SHA-256.
* `protocol` - The protocol of the identity provider. Either SAML or OIDC.
Copy link
Member

Choose a reason for hiding this comment

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

maybe it would be good in each attribute to say if it's mandatory depending on the protocol. like... this is mandatory for SAML protocol.

Copy link
Collaborator Author

@oarbusi oarbusi Jan 30, 2024

Choose a reason for hiding this comment

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

Maybe required would not be the right word, since it's not actually required, I'm not sure about it. I'm open to opinions

Copy link
Collaborator

@pierwill pierwill left a comment

Choose a reason for hiding this comment

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

Some suggestions. In general, literal values should be in backticks throughout.

oarbusi and others added 8 commits January 31, 2024 09:24
Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com>
…down

Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com>
Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com>
Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com>
Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com>
Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com>
Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com>
Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com>
@oarbusi oarbusi requested a review from pierwill January 31, 2024 08:25
Co-authored-by: Agustin Bettati <bettatiagustin@gmail.com>
@oarbusi oarbusi merged commit 86edeed into master Feb 1, 2024
38 checks passed
@oarbusi oarbusi deleted the CLOUDP-220800 branch February 1, 2024 08:28
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.

None yet

6 participants