diff --git a/overseerr-api.yml b/overseerr-api.yml index 90b90d11d..b4047e52f 100644 --- a/overseerr-api.yml +++ b/overseerr-api.yml @@ -7,8 +7,8 @@ info: Two primary authentication methods are supported: - - **Cookie Authentication**: A valid login to the `/auth/login` or `/auth/local` will generate a valid authentication cookie. - - **API Key Authentication**: Login is also possible by passing an `X-Api-Key` header along with a valid API Key generated by Overseerr. + - **Cookie Authentication**: A valid sign-in to the `/auth/plex` or `/auth/local` will generate a valid authentication cookie. + - **API Key Authentication**: Sign-in is also possible by passing an `X-Api-Key` header along with a valid API Key generated by Overseerr. tags: - name: public description: Public API endpoints requiring no authentication. @@ -2613,7 +2613,7 @@ paths: application/json: schema: $ref: '#/components/schemas/User' - /auth/login: + /auth/plex: post: summary: Sign in using a Plex token description: Takes an `authToken` (Plex token) to log the user in. Generates a session cookie for use in further requests. If the user does not exist, and there are no other users, then a user will be created with full admin privileges. If a user logs in with access to the main Plex server, they will also have an account created, but without any permissions.