openapi: add reset user password endpoint specification

This commit is contained in:
juancarmore 2026-01-12 17:26:15 +01:00
parent 23154bd380
commit c60cb244a7
7 changed files with 69 additions and 6 deletions

View File

@ -0,0 +1,12 @@
description: Reset user password request
required: true
content:
application/json:
schema:
type: object
properties:
newPassword:
type: string
minLength: 5
description: The new temporary password for the user.
example: 'newSecurePassword123'

View File

@ -7,3 +7,11 @@ content:
message:
type: string
example: Password for user 'admin' changed successfully
accessToken:
type: string
description: >
The access token to authenticate the user in subsequent requests. Only present when password had to be changed.
refreshToken:
type: string
description: >
The refresh token to obtain a new access token when the current one expires. Only present when password had to be changed.

View File

@ -0,0 +1,9 @@
description: Successfully changed user password
content:
application/json:
schema:
type: object
properties:
message:
type: string
example: Password for user 'alice_smith' has been reset successfully. User must change password on next login.

View File

@ -15,3 +15,8 @@ content:
type: string
description: >
The refresh token to obtain a new access token when the current one expires.
mustChangePassword:
type: boolean
example: true
description: >
Indicates whether the user must change their password after login. Only present if password change is required.

View File

@ -24,6 +24,8 @@ paths:
$ref: './paths/internal/users.yaml#/~1users~1change-password'
/users/{userId}:
$ref: './paths/internal/users.yaml#/~1users~1{userId}'
/users/{userId}/password:
$ref: './paths/internal/users.yaml#/~1users~1{userId}~1password'
/config/webhooks:
$ref: './paths/internal/meet-global-config.yaml#/~1config~1webhooks'
/config/webhooks/test:

View File

@ -15,9 +15,9 @@
'201':
$ref: '../../components/responses/internal/success-create-api-key.yaml'
'401':
$ref: '../components/responses/unauthorized-error.yaml'
$ref: '../../components/responses/unauthorized-error.yaml'
'403':
$ref: '../components/responses/forbidden-error.yaml'
$ref: '../../components/responses/forbidden-error.yaml'
'500':
$ref: '../../components/responses/internal-server-error.yaml'
get:
@ -36,9 +36,9 @@
'200':
$ref: '../../components/responses/internal/success-get-api-keys.yaml'
'401':
$ref: '../components/responses/unauthorized-error.yaml'
$ref: '../../components/responses/unauthorized-error.yaml'
'403':
$ref: '../components/responses/forbidden-error.yaml'
$ref: '../../components/responses/forbidden-error.yaml'
'500':
$ref: '../../components/responses/internal-server-error.yaml'
delete:
@ -54,8 +54,8 @@
'200':
$ref: '../../components/responses/internal/success-delete-api-key.yaml'
'401':
$ref: '../components/responses/unauthorized-error.yaml'
$ref: '../../components/responses/unauthorized-error.yaml'
'403':
$ref: '../components/responses/forbidden-error.yaml'
$ref: '../../components/responses/forbidden-error.yaml'
'500':
$ref: '../../components/responses/internal-server-error.yaml'

View File

@ -166,3 +166,30 @@
$ref: '../../components/responses/internal/error-user-not-found.yaml'
'500':
$ref: '../../components/responses/internal-server-error.yaml'
/users/{userId}/password:
put:
operationId: resetUserPassword
summary: Reset user password
description: >
Allows an admin to reset the password of a specific user.
tags:
- Internal API - Users
security:
- accessTokenHeader: []
parameters:
- $ref: '../../components/parameters/internal/user-id-path.yaml'
requestBody:
$ref: '../../components/requestBodies/internal/reset-password-request.yaml'
responses:
'200':
$ref: '../../components/responses/internal/success-reset-password.yaml'
'401':
$ref: '../../components/responses/unauthorized-error.yaml'
'403':
$ref: '../../components/responses/forbidden-error.yaml'
'404':
$ref: '../../components/responses/internal/error-user-not-found.yaml'
'422':
$ref: '../../components/responses/validation-error.yaml'
'500':
$ref: '../../components/responses/internal-server-error.yaml'