openapi: 3.2.0
info:
title: Beacon Rest Services Set Password API
description: 'A combination of all methods in the beacon-api
[ BASE URL: https://beaconproplus.com
Beacon ProPlus
Version 1: https://beaconproplus.com/v1/rest/com/becn
Version 2: https://beaconproplus.com/v2/rest/com/becn
Version 3: https://beaconproplus.com/v3/rest/com/becn
Beacon Stack
[ BASE URL: https://beacon-api-x7xzzdp35a-uk.a.run.app
Version 1: https://beacon-api-x7xzzdp35a-uk.a.run.app/v1/rest/com/becn/
Version 2: https://beacon-api-x7xzzdp35a-uk.a.run.app/v2/rest/com/becn/
Version 3…'
version: '1.0'
contact: {}
servers: []
tags:
- name: SetPassword
paths:
/setPassword:
post:
operationId: V2Controller_setPassword
summary: Sets password for new user
description: Sets password for new users using the password token.
parameters: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/setPasswordBody'
responses:
'200':
description: successful operation
refer to the API Uniform Format dropdown above
content:
application/json:
schema:
$ref: '#/components/schemas/setPasswordResponse'
'400':
description: Bad Request, accountId is invalid.
'401':
description: Unauthorized, the authorization bearer token is invalid.
'405':
description: Method not allowed, the request method is not valid for this API or this API is not available.
'500':
description: Internal exception.
tags:
- SetPassword
components:
schemas:
Message:
type: object
properties:
type:
type: string
value:
type: string
code:
type: string
required:
- type
- value
- code
setPasswordResponse:
type: object
properties:
messages:
type: array
items:
$ref: '#/components/schemas/Message'
messageCode:
type: number
success:
type: boolean
required:
- messages
- messageCode
- success
setPasswordBody:
type: object
properties:
password:
type: string
confirmpassword:
type: string
passwordtoken:
type: string
required:
- password
- confirmpassword
- passwordtoken