TeskaLabs / seacat-auth

SeaCat Auth provides authentication, authorization, identity management, session management and other access control features.
GNU General Public License v3.0
11 stars 6 forks source link

Move NGINX introspection endpoints to private API (post-fix) #311

Closed byewokko closed 11 months ago

byewokko commented 11 months ago

this is a post-fix to #301

Breaking changes

Migration

In your NGINX configuration, simply replace the old paths with the new ones:

OLD endpoint NEW endpoint
POST {PUBLIC_API}/openidconnect/introspect/nginx POST {PRIVATE_API}/nginx/introspect/openidconnect
POST {PUBLIC_API}/cookie/nginx POST {PRIVATE_API}/nginx/introspect/cookie
POST {PUBLIC_API}/cookie/nginx/anonymous POST {PRIVATE_API}/nginx/introspect/cookie/anonymous
POST {PUBLIC_API}/m2m/nginx POST {PRIVATE_API}/nginx/introspect/m2m
PUT {PUBLIC_API}/batman/nginx POST {PRIVATE_API}/nginx/introspect/batman

Backwards compatibility

To keep the old public endpoints available while you transition to the new private ones, use the following config option:

[seacatauth:introspection]
_enable_legacy_endpoints=yes

Note that this setting should be used only temporarily for the period of migration, to minimize the impact to network traffic. This functionality will be removed soon.