chore: update specification

This commit is contained in:
Paul Makles
2022-11-19 16:37:09 +00:00
parent b3ebe9d967
commit 1cfb946ca6
5 changed files with 131 additions and 59 deletions
+92 -38
View File
@@ -3929,8 +3929,15 @@
}
}
},
"204": {
"description": "Success"
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResponseVerify"
}
}
}
}
}
}
@@ -9438,6 +9445,20 @@
}
}
},
{
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"type": "string",
"enum": [
"LockedOut"
]
}
}
},
{
"type": "object",
"required": [
@@ -9578,6 +9599,67 @@
}
}
},
"ResponseVerify": {
"anyOf": [
{
"type": "null"
},
{
"type": "object",
"required": [
"ticket"
],
"properties": {
"ticket": {
"description": "Authorised MFA ticket, can be used to log in",
"allOf": [
{
"$ref": "#/components/schemas/MFATicket"
}
]
}
}
}
]
},
"MFATicket": {
"description": "Multi-factor auth ticket",
"type": "object",
"required": [
"_id",
"account_id",
"authorised",
"token",
"validated"
],
"properties": {
"_id": {
"description": "Unique Id",
"type": "string"
},
"account_id": {
"description": "Account Id",
"type": "string"
},
"token": {
"description": "Unique Token",
"type": "string"
},
"validated": {
"description": "Whether this ticket has been validated (can be used for account actions)",
"type": "boolean"
},
"authorised": {
"description": "Whether this ticket is authorised (can be used to log a user in)",
"type": "boolean"
},
"last_totp_code": {
"description": "TOTP code at time of ticket creation",
"type": "string",
"nullable": true
}
}
},
"DataPasswordReset": {
"title": "Password Reset",
"type": "object",
@@ -9593,6 +9675,11 @@
"password": {
"description": "New password",
"type": "string"
},
"remove_sessions": {
"description": "Whether to logout all sessions",
"default": false,
"type": "boolean"
}
}
},
@@ -9734,11 +9821,6 @@
"description": "Password",
"type": "string"
},
"captcha": {
"description": "Captcha verification code",
"type": "string",
"nullable": true
},
"friendly_name": {
"description": "Friendly name used for the session",
"type": "string",
@@ -9749,12 +9831,11 @@
{
"type": "object",
"required": [
"mfa_response",
"mfa_ticket"
],
"properties": {
"mfa_ticket": {
"description": "Unvalidated MFA ticket\n\nUsed to resolve the correct account",
"description": "Unvalidated or authorised MFA ticket\n\nUsed to resolve the correct account",
"type": "string"
},
"mfa_response": {
@@ -9763,7 +9844,8 @@
{
"$ref": "#/components/schemas/MFAResponse"
}
]
],
"nullable": true
},
"friendly_name": {
"description": "Friendly name used for the session",
@@ -9840,34 +9922,6 @@
}
}
},
"MFATicket": {
"description": "Multi-factor auth ticket",
"type": "object",
"required": [
"_id",
"account_id",
"token",
"validated"
],
"properties": {
"_id": {
"description": "Unique Id",
"type": "string"
},
"account_id": {
"description": "Account Id",
"type": "string"
},
"token": {
"description": "Unique Token",
"type": "string"
},
"validated": {
"description": "Whether this ticket has been validated",
"type": "boolean"
}
}
},
"MultiFactorStatus": {
"type": "object",
"required": [