diff --git a/pkg/swagger/docs.go b/pkg/swagger/docs.go index fb3dfccdc..93de88c59 100644 --- a/pkg/swagger/docs.go +++ b/pkg/swagger/docs.go @@ -7456,7 +7456,7 @@ const docTemplate = `{ }, "/user/logout": { "post": { - "description": "Destroys the current session and clears the refresh token cookie.", + "description": "Destroys the current session and clears the refresh token cookie. For OpenID Connect sessions the response includes an ` + "`" + `oidc_logout_url` + "`" + ` the client should redirect to so the provider session is ended too.", "produces": [ "application/json" ], @@ -7468,7 +7468,7 @@ const docTemplate = `{ "200": { "description": "Successfully logged out.", "schema": { - "$ref": "#/definitions/models.Message" + "$ref": "#/definitions/v1.LogoutResponse" } } } @@ -11149,6 +11149,18 @@ const docTemplate = `{ } } }, + "v1.LogoutResponse": { + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "oidc_logout_url": { + "description": "RP-Initiated Logout URL the frontend redirects to. Empty for non-OIDC sessions.", + "type": "string" + } + } + }, "v1.UserAvatarProvider": { "type": "object", "properties": { diff --git a/pkg/swagger/swagger.json b/pkg/swagger/swagger.json index 4fc8cfe9a..f02bf9bde 100644 --- a/pkg/swagger/swagger.json +++ b/pkg/swagger/swagger.json @@ -7448,7 +7448,7 @@ }, "/user/logout": { "post": { - "description": "Destroys the current session and clears the refresh token cookie.", + "description": "Destroys the current session and clears the refresh token cookie. For OpenID Connect sessions the response includes an `oidc_logout_url` the client should redirect to so the provider session is ended too.", "produces": [ "application/json" ], @@ -7460,7 +7460,7 @@ "200": { "description": "Successfully logged out.", "schema": { - "$ref": "#/definitions/models.Message" + "$ref": "#/definitions/v1.LogoutResponse" } } } @@ -11141,6 +11141,18 @@ } } }, + "v1.LogoutResponse": { + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "oidc_logout_url": { + "description": "RP-Initiated Logout URL the frontend redirects to. Empty for non-OIDC sessions.", + "type": "string" + } + } + }, "v1.UserAvatarProvider": { "type": "object", "properties": { diff --git a/pkg/swagger/swagger.yaml b/pkg/swagger/swagger.yaml index de0e5fbe2..775b2a024 100644 --- a/pkg/swagger/swagger.yaml +++ b/pkg/swagger/swagger.yaml @@ -1714,6 +1714,15 @@ definitions: password: type: string type: object + v1.LogoutResponse: + properties: + message: + type: string + oidc_logout_url: + description: RP-Initiated Logout URL the frontend redirects to. Empty for + non-OIDC sessions. + type: string + type: object v1.UserAvatarProvider: properties: avatar_provider: @@ -6945,13 +6954,15 @@ paths: /user/logout: post: description: Destroys the current session and clears the refresh token cookie. + For OpenID Connect sessions the response includes an `oidc_logout_url` the + client should redirect to so the provider session is ended too. produces: - application/json responses: "200": description: Successfully logged out. schema: - $ref: '#/definitions/models.Message' + $ref: '#/definitions/v1.LogoutResponse' summary: Logout tags: - auth