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

refactor: all admin endpoints are now exposed under /admin/ on the … #2292

Merged
merged 3 commits into from
Mar 9, 2022

Conversation

aeneasr
Copy link
Member

@aeneasr aeneasr commented Mar 7, 2022

…admin port

BREAKING CHANGE: All endpoints at the Admin API are now exposed at /admin/. For example, endpoint https://kratos:4434/identities is now exposed at https://kratos:4434/admin/identities. This change makes it easier to configure reverse proxies and API Gateways. Additionally, it introduces 1:1 compatibility between Ory Cloud's APIs and self-hosted Ory Kratos. Please note that nothing has changed in terms of the port. To make the migration less painful, we have set up redirects from the old endpoints to the new /admin endpoints, so your APIs, SDKs, and clients should continue working as they were working before. This change is marked as a breaking change as it touches many endpoints and might be confusing when encountering the redirect for the first time.

Related issue(s)

Checklist

  • I have read the contributing guidelines.
  • I have referenced an issue containing the design document if my change
    introduces a new feature.
  • I am following the
    contributing code guidelines.
  • I have read the security policy.
  • I confirm that this pull request does not address a security
    vulnerability. If this pull request addresses a security. vulnerability, I
    confirm that I got green light (please contact
    security@ory.sh) from the maintainers to push
    the changes.
  • I have added tests that prove my fix is effective or that my feature
    works.
  • I have added or changed the documentation.

Further Comments

@aeneasr aeneasr requested a review from zepatrik as a code owner March 7, 2022 21:42
@aeneasr aeneasr self-assigned this Mar 7, 2022
aeneasr added a commit to ory/docs that referenced this pull request Mar 7, 2022
@aeneasr aeneasr closed this Mar 7, 2022
@aeneasr aeneasr reopened this Mar 7, 2022
aeneasr added a commit to ory/docs that referenced this pull request Mar 7, 2022
@aeneasr aeneasr force-pushed the admin-endpoints branch 2 times, most recently from d9b14cb to 4ffc910 Compare March 8, 2022 06:54
@codecov
Copy link

codecov bot commented Mar 8, 2022

Codecov Report

❗ No coverage uploaded for pull request base (master@c7682a8). Click here to learn what that means.
The diff coverage is 73.49%.

❗ Current head 34084af differs from pull request most recent head 453b649. Consider uploading reports for the commit 453b649 to get more accurate results

Impacted file tree graph

@@            Coverage Diff            @@
##             master    #2292   +/-   ##
=========================================
  Coverage          ?   76.59%           
=========================================
  Files             ?      318           
  Lines             ?    17134           
  Branches          ?        0           
=========================================
  Hits              ?    13124           
  Misses            ?     3080           
  Partials          ?      930           
Impacted Files Coverage Δ
selfservice/strategy/link/strategy_recovery.go 63.17% <ø> (ø)
session/handler.go 70.06% <ø> (ø)
x/nocache.go 40.00% <10.00%> (ø)
x/router.go 68.18% <62.85%> (ø)
cmd/daemon/serve.go 82.95% <100.00%> (ø)
driver/config/handler.go 100.00% <100.00%> (ø)
driver/registry_default.go 86.80% <100.00%> (ø)
identity/handler.go 85.71% <100.00%> (ø)
internal/testhelpers/server.go 90.47% <100.00%> (ø)
schema/handler.go 82.27% <100.00%> (ø)
... and 2 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update c7682a8...453b649. Read the comment docs.

@aeneasr aeneasr force-pushed the admin-endpoints branch 2 times, most recently from 5b383a6 to 0e64ad8 Compare March 8, 2022 21:46
…admin port

BREAKING CHANGE: All endpoints at the Admin API are now exposed at `/admin/`. For example, endpoint `https://kratos:4434/identities` is now exposed at `https://kratos:4434/admin/identities`. This change makes it easier to configure reverse proxies and API Gateways. Additionally, it introduces 1:1 compatibility between Ory Cloud's APIs and self-hosted Ory Kratos. Please note that nothing has changed in terms of the port. To make the migration less painful, we have set up redirects from the old endpoints to the new `/admin` endpoints, so your APIs, SDKs, and clients should continue working as they were working before. This change is marked as a breaking change as it touches many endpoints and might be confusing when encountering the redirect for the first time.
@aeneasr aeneasr merged commit dbcf3fb into master Mar 9, 2022
@aeneasr aeneasr deleted the admin-endpoints branch March 9, 2022 15:33
aeneasr added a commit to ory/docs that referenced this pull request Mar 21, 2022
aeneasr added a commit to ory/docs that referenced this pull request Mar 21, 2022
zepatrik added a commit that referenced this pull request Apr 11, 2022
Windows users were broken since #2292, as routes were registered with backslashes.
peturgeorgievv pushed a commit to senteca/kratos-fork that referenced this pull request Jun 30, 2023
Windows users were broken since ory#2292, as routes were registered with backslashes.
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

1 participant