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

BED-5013: Deprecate Create SAML Endpoint #1033

Merged
merged 13 commits into from
Dec 20, 2024
Merged

BED-5013: Deprecate Create SAML Endpoint #1033

merged 13 commits into from
Dec 20, 2024

Conversation

iustinum
Copy link
Contributor

Description

This PR adds a new SSO endpoint POST /api/v2/sso-providers/saml to replace the existing POST /api/v2/saml/providers endpoint. The old endpoint is marked as deprecated, and OpenAPI documentation is updated accordingly.

Motivation and Context

This PR addresses: BED-5013

By migrating to the new endpoint, we standardize SSO provider interactions and guide users away from the soon-to-be-removed SAML-specific endpoints.

How Has This Been Tested?

  • Verified endpoint functionality through existing integration tests.
  • Confirmed that both old and new endpoints return expected responses.
  • Reviewed documentation and ensured it reflects the new endpoint and deprecation notice.

Screenshots (optional):

Types of changes

  • Chore (a change that does not modify the application functionality)

Checklist:

@iustinum iustinum self-assigned this Dec 20, 2024
cmd/api/src/api/registration/v2.go Outdated Show resolved Hide resolved
packages/go/openapi/src/paths/auth.sso-providers.saml.yaml Outdated Show resolved Hide resolved
cmd/api/src/api/registration/v2.go Outdated Show resolved Hide resolved
@iustinum iustinum requested a review from mistahj67 December 20, 2024 21:20
@iustinum iustinum added documentation Improvements or additions to documentation api A pull request containing changes affecting the API code. labels Dec 20, 2024
Copy link
Contributor

@mistahj67 mistahj67 left a comment

Choose a reason for hiding this comment

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

Code LGTM and locally tested

@iustinum iustinum merged commit b4fcdc9 into main Dec 20, 2024
4 checks passed
@iustinum iustinum deleted the BED-5013 branch December 20, 2024 22:19
@github-actions github-actions bot locked and limited conversation to collaborators Dec 20, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
api A pull request containing changes affecting the API code. documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants