Password Reset

openapi: 3.0.0 info: description: >- The `Password Reset` API is capable of sending a password reset link to a user and can also retrieve or update the financial institution's settings related to password resets. version: '0.0' title: Password Reset tags: - name: Institution Settings - name: Send Reset Link servers: - url: 'https://banno.com' paths: '/a/password-reset/api/v0/institutions/{institutionId}/users/{userId}/password/reset': post: tags: - Send Reset Link description: | Sends a password reset link to the user, using the institution's password-reset settings. Requires the "Manage security settings" permission security: - clientCredentials: [] parameters: - in: path name: institutionId description: the user's institution required: true schema: type: string - in: path name: userId description: ID of the user to be reset required: true schema: type: string requestBody: content: application/json: schema: type: object properties: method: type: string description: Channel to send the reset link. enum: [email, sms] required: true responses: '200': description: OK content: application/json: schema: type: object example: {} '500': description: Server error '/a/password-reset/api/v0/institutions/{institutionId}/settings': get: tags: - Institution Settings description: | Retrieves an institution's settings for password reset. Requires the "View" permission for People security: - clientCredentials: [] parameters: - in: path name: institutionId required: true schema: type: string responses: '200': description: OK content: application/json: schema: properties: expiration: type: number description: Lifetime of reset links (in seconds). Defaults to 1 hour. example: 3600 '500': description: Server error put: tags: - Institution Settings description: | Sets an institution's settings for password reset. Requires the "Manage everything – users, messages & settings" permission security: - clientCredentials: [] parameters: - in: path name: institutionId required: true schema: type: string requestBody: content: application/json: schema: type: object properties: expiration: type: number description: Lifetime of reset links (in seconds). example: 86400 required: true responses: '204': description: OK; no content '500': description: Server error components: securitySchemes: clientCredentials: type: oauth2 description: OAuth2 using the client credentials flow flows: clientCredentials: tokenUrl: https://banno.com/a/oidc-provider/api/v0/token scopes: {}