Created
June 30, 2022 13:45
-
-
Save ivyxjc/07592a547f16423634b2effdf6cdafc4 to your computer and use it in GitHub Desktop.
bitwarden internal openapi
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
{ | |
"openapi": "3.0.1", | |
"info": { | |
"title": "Bitwarden Internal API", | |
"version": "latest" | |
}, | |
"servers": [ | |
{ | |
"url": "https://api.bitwarden.com" | |
} | |
], | |
"paths": { | |
"/accounts/prelogin": { | |
"post": { | |
"tags": [ | |
"Accounts" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/PreloginRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/PreloginRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/PreloginRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/PreloginResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/PreloginResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/PreloginResponseModel" | |
} | |
} | |
} | |
} | |
}, | |
"deprecated": true | |
} | |
}, | |
"/accounts/register": { | |
"post": { | |
"tags": [ | |
"Accounts" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/RegisterRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/RegisterRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/RegisterRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
}, | |
"deprecated": true | |
} | |
}, | |
"/accounts/password-hint": { | |
"post": { | |
"tags": [ | |
"Accounts" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/PasswordHintRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/PasswordHintRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/PasswordHintRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/accounts/email-token": { | |
"post": { | |
"tags": [ | |
"Accounts" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/EmailTokenRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/EmailTokenRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/EmailTokenRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/accounts/email": { | |
"post": { | |
"tags": [ | |
"Accounts" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/EmailRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/EmailRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/EmailRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/accounts/verify-email": { | |
"post": { | |
"tags": [ | |
"Accounts" | |
], | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/accounts/verify-email-token": { | |
"post": { | |
"tags": [ | |
"Accounts" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/VerifyEmailRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/VerifyEmailRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/VerifyEmailRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/accounts/password": { | |
"post": { | |
"tags": [ | |
"Accounts" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/PasswordRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/PasswordRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/PasswordRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/accounts/set-password": { | |
"post": { | |
"tags": [ | |
"Accounts" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/SetPasswordRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/SetPasswordRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/SetPasswordRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/accounts/verify-password": { | |
"post": { | |
"tags": [ | |
"Accounts" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/SecretVerificationRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/SecretVerificationRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/SecretVerificationRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/accounts/set-key-connector-key": { | |
"post": { | |
"tags": [ | |
"Accounts" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/SetKeyConnectorKeyRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/SetKeyConnectorKeyRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/SetKeyConnectorKeyRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/accounts/convert-to-key-connector": { | |
"post": { | |
"tags": [ | |
"Accounts" | |
], | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/accounts/kdf": { | |
"post": { | |
"tags": [ | |
"Accounts" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/KdfRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/KdfRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/KdfRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/accounts/key": { | |
"post": { | |
"tags": [ | |
"Accounts" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/UpdateKeyRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/UpdateKeyRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/UpdateKeyRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/accounts/security-stamp": { | |
"post": { | |
"tags": [ | |
"Accounts" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/SecretVerificationRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/SecretVerificationRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/SecretVerificationRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/accounts/profile": { | |
"get": { | |
"tags": [ | |
"Accounts" | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/ProfileResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ProfileResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ProfileResponseModel" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"put": { | |
"tags": [ | |
"Accounts" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/UpdateProfileRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/UpdateProfileRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/UpdateProfileRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/ProfileResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ProfileResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ProfileResponseModel" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"post": { | |
"tags": [ | |
"Accounts" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/UpdateProfileRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/UpdateProfileRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/UpdateProfileRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/ProfileResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ProfileResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ProfileResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/accounts/organizations": { | |
"get": { | |
"tags": [ | |
"Accounts" | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/ProfileOrganizationResponseModelListResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ProfileOrganizationResponseModelListResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ProfileOrganizationResponseModelListResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/accounts/revision-date": { | |
"get": { | |
"tags": [ | |
"Accounts" | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"type": "integer", | |
"format": "int64" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"type": "integer", | |
"format": "int64" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"type": "integer", | |
"format": "int64" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/accounts/keys": { | |
"post": { | |
"tags": [ | |
"Accounts" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/KeysRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/KeysRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/KeysRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/KeysResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/KeysResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/KeysResponseModel" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"get": { | |
"tags": [ | |
"Accounts" | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/KeysResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/KeysResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/KeysResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/accounts/delete": { | |
"post": { | |
"tags": [ | |
"Accounts" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/SecretVerificationRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/SecretVerificationRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/SecretVerificationRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/accounts": { | |
"delete": { | |
"tags": [ | |
"Accounts" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/SecretVerificationRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/SecretVerificationRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/SecretVerificationRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/accounts/delete-recover": { | |
"post": { | |
"tags": [ | |
"Accounts" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/DeleteRecoverRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/DeleteRecoverRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/DeleteRecoverRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/accounts/delete-recover-token": { | |
"post": { | |
"tags": [ | |
"Accounts" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/VerifyDeleteRecoverRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/VerifyDeleteRecoverRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/VerifyDeleteRecoverRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/accounts/iap-check": { | |
"post": { | |
"tags": [ | |
"Accounts" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/IapCheckRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/IapCheckRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/IapCheckRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/accounts/premium": { | |
"post": { | |
"tags": [ | |
"Accounts" | |
], | |
"parameters": [ | |
{ | |
"name": "paymentMethodType", | |
"in": "query", | |
"required": true, | |
"schema": { | |
"$ref": "#/components/schemas/PaymentMethodType" | |
} | |
}, | |
{ | |
"name": "paymentToken", | |
"in": "query", | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"name": "additionalStorageGb", | |
"in": "query", | |
"schema": { | |
"maximum": 99, | |
"minimum": 0, | |
"type": "integer", | |
"format": "int32" | |
} | |
}, | |
{ | |
"name": "country", | |
"in": "query", | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"name": "postalCode", | |
"in": "query", | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"multipart/form-data": { | |
"schema": { | |
"type": "object", | |
"properties": { | |
"license": { | |
"type": "string", | |
"format": "binary" | |
} | |
} | |
}, | |
"encoding": { | |
"license": { | |
"style": "form" | |
} | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/PaymentResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/PaymentResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/PaymentResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/accounts/billing": { | |
"get": { | |
"tags": [ | |
"Accounts" | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/BillingResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/BillingResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/BillingResponseModel" | |
} | |
} | |
} | |
} | |
}, | |
"deprecated": true | |
} | |
}, | |
"/accounts/subscription": { | |
"get": { | |
"tags": [ | |
"Accounts" | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/SubscriptionResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/SubscriptionResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/SubscriptionResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/accounts/payment": { | |
"post": { | |
"tags": [ | |
"Accounts" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/PaymentRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/PaymentRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/PaymentRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/accounts/storage": { | |
"post": { | |
"tags": [ | |
"Accounts" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/StorageRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/StorageRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/StorageRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/PaymentResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/PaymentResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/PaymentResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/accounts/license": { | |
"post": { | |
"tags": [ | |
"Accounts" | |
], | |
"requestBody": { | |
"content": { | |
"multipart/form-data": { | |
"schema": { | |
"required": [ | |
"license" | |
], | |
"type": "object", | |
"properties": { | |
"license": { | |
"type": "string", | |
"format": "binary" | |
} | |
} | |
}, | |
"encoding": { | |
"license": { | |
"style": "form" | |
} | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/accounts/cancel-premium": { | |
"post": { | |
"tags": [ | |
"Accounts" | |
], | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/accounts/reinstate-premium": { | |
"post": { | |
"tags": [ | |
"Accounts" | |
], | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/accounts/tax": { | |
"get": { | |
"tags": [ | |
"Accounts" | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/TaxInfoResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/TaxInfoResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/TaxInfoResponseModel" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"put": { | |
"tags": [ | |
"Accounts" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/TaxInfoUpdateRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/TaxInfoUpdateRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/TaxInfoUpdateRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/accounts/sso/{organizationId}": { | |
"delete": { | |
"tags": [ | |
"Accounts" | |
], | |
"parameters": [ | |
{ | |
"name": "organizationId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/accounts/sso/user-identifier": { | |
"get": { | |
"tags": [ | |
"Accounts" | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"type": "string" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"type": "string" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/accounts/api-key": { | |
"post": { | |
"tags": [ | |
"Accounts" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/SecretVerificationRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/SecretVerificationRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/SecretVerificationRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiKeyResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiKeyResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiKeyResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/accounts/rotate-api-key": { | |
"post": { | |
"tags": [ | |
"Accounts" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/SecretVerificationRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/SecretVerificationRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/SecretVerificationRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiKeyResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiKeyResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiKeyResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/accounts/update-temp-password": { | |
"put": { | |
"tags": [ | |
"Accounts" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/UpdateTempPasswordRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/UpdateTempPasswordRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/UpdateTempPasswordRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/accounts/request-otp": { | |
"post": { | |
"tags": [ | |
"Accounts" | |
], | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/accounts/verify-otp": { | |
"post": { | |
"tags": [ | |
"Accounts" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/VerifyOTPRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/VerifyOTPRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/VerifyOTPRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/accounts/billing/history": { | |
"get": { | |
"tags": [ | |
"AccountsBilling" | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/BillingHistoryResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/BillingHistoryResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/BillingHistoryResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/accounts/billing/payment-method": { | |
"get": { | |
"tags": [ | |
"AccountsBilling" | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/BillingPaymentResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/BillingPaymentResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/BillingPaymentResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/ciphers/{id}": { | |
"get": { | |
"tags": [ | |
"Ciphers" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherResponseModel" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"put": { | |
"tags": [ | |
"Ciphers" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherResponseModel" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"post": { | |
"tags": [ | |
"Ciphers" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherResponseModel" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"delete": { | |
"tags": [ | |
"Ciphers" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/ciphers/{id}/admin": { | |
"get": { | |
"tags": [ | |
"Ciphers" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherMiniResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherMiniResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherMiniResponseModel" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"put": { | |
"tags": [ | |
"Ciphers" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherMiniResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherMiniResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherMiniResponseModel" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"post": { | |
"tags": [ | |
"Ciphers" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherMiniResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherMiniResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherMiniResponseModel" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"delete": { | |
"tags": [ | |
"Ciphers" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/ciphers/{id}/full-details": { | |
"get": { | |
"tags": [ | |
"Ciphers" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherDetailsResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherDetailsResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherDetailsResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/ciphers/{id}/details": { | |
"get": { | |
"tags": [ | |
"Ciphers" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherDetailsResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherDetailsResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherDetailsResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/ciphers": { | |
"get": { | |
"tags": [ | |
"Ciphers" | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherDetailsResponseModelListResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherDetailsResponseModelListResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherDetailsResponseModelListResponseModel" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"post": { | |
"tags": [ | |
"Ciphers" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherResponseModel" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"delete": { | |
"tags": [ | |
"Ciphers" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherBulkDeleteRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherBulkDeleteRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherBulkDeleteRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/ciphers/create": { | |
"post": { | |
"tags": [ | |
"Ciphers" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherCreateRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherCreateRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherCreateRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/ciphers/admin": { | |
"post": { | |
"tags": [ | |
"Ciphers" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherCreateRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherCreateRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherCreateRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherMiniResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherMiniResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherMiniResponseModel" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"delete": { | |
"tags": [ | |
"Ciphers" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherBulkDeleteRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherBulkDeleteRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherBulkDeleteRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/ciphers/organization-details": { | |
"get": { | |
"tags": [ | |
"Ciphers" | |
], | |
"parameters": [ | |
{ | |
"name": "organizationId", | |
"in": "query", | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherMiniDetailsResponseModelListResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherMiniDetailsResponseModelListResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherMiniDetailsResponseModelListResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/ciphers/import": { | |
"post": { | |
"tags": [ | |
"Ciphers" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ImportCiphersRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ImportCiphersRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/ImportCiphersRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/ciphers/import-organization": { | |
"post": { | |
"tags": [ | |
"Ciphers" | |
], | |
"parameters": [ | |
{ | |
"name": "organizationId", | |
"in": "query", | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ImportOrganizationCiphersRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ImportOrganizationCiphersRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/ImportOrganizationCiphersRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/ciphers/{id}/partial": { | |
"put": { | |
"tags": [ | |
"Ciphers" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherPartialRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherPartialRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherPartialRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
}, | |
"post": { | |
"tags": [ | |
"Ciphers" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherPartialRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherPartialRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherPartialRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/ciphers/{id}/share": { | |
"put": { | |
"tags": [ | |
"Ciphers" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherShareRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherShareRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherShareRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherResponseModel" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"post": { | |
"tags": [ | |
"Ciphers" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherShareRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherShareRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherShareRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/ciphers/{id}/collections": { | |
"put": { | |
"tags": [ | |
"Ciphers" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherCollectionsRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherCollectionsRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherCollectionsRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
}, | |
"post": { | |
"tags": [ | |
"Ciphers" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherCollectionsRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherCollectionsRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherCollectionsRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/ciphers/{id}/collections-admin": { | |
"put": { | |
"tags": [ | |
"Ciphers" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherCollectionsRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherCollectionsRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherCollectionsRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
}, | |
"post": { | |
"tags": [ | |
"Ciphers" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherCollectionsRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherCollectionsRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherCollectionsRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/ciphers/{id}/delete": { | |
"post": { | |
"tags": [ | |
"Ciphers" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
}, | |
"put": { | |
"tags": [ | |
"Ciphers" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/ciphers/{id}/delete-admin": { | |
"post": { | |
"tags": [ | |
"Ciphers" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
}, | |
"put": { | |
"tags": [ | |
"Ciphers" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/ciphers/delete": { | |
"post": { | |
"tags": [ | |
"Ciphers" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherBulkDeleteRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherBulkDeleteRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherBulkDeleteRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
}, | |
"put": { | |
"tags": [ | |
"Ciphers" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherBulkDeleteRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherBulkDeleteRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherBulkDeleteRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/ciphers/delete-admin": { | |
"post": { | |
"tags": [ | |
"Ciphers" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherBulkDeleteRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherBulkDeleteRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherBulkDeleteRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
}, | |
"put": { | |
"tags": [ | |
"Ciphers" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherBulkDeleteRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherBulkDeleteRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherBulkDeleteRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/ciphers/{id}/restore": { | |
"put": { | |
"tags": [ | |
"Ciphers" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/ciphers/{id}/restore-admin": { | |
"put": { | |
"tags": [ | |
"Ciphers" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherMiniResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherMiniResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherMiniResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/ciphers/restore": { | |
"put": { | |
"tags": [ | |
"Ciphers" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherBulkRestoreRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherBulkRestoreRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherBulkRestoreRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherResponseModelListResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherResponseModelListResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherResponseModelListResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/ciphers/move": { | |
"put": { | |
"tags": [ | |
"Ciphers" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherBulkMoveRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherBulkMoveRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherBulkMoveRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
}, | |
"post": { | |
"tags": [ | |
"Ciphers" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherBulkMoveRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherBulkMoveRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherBulkMoveRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/ciphers/share": { | |
"put": { | |
"tags": [ | |
"Ciphers" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherBulkShareRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherBulkShareRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherBulkShareRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
}, | |
"post": { | |
"tags": [ | |
"Ciphers" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherBulkShareRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherBulkShareRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherBulkShareRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/ciphers/purge": { | |
"post": { | |
"tags": [ | |
"Ciphers" | |
], | |
"parameters": [ | |
{ | |
"name": "organizationId", | |
"in": "query", | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/SecretVerificationRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/SecretVerificationRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/SecretVerificationRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/ciphers/{id}/attachment/v2": { | |
"post": { | |
"tags": [ | |
"Ciphers" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/AttachmentRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/AttachmentRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/AttachmentRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/AttachmentUploadDataResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/AttachmentUploadDataResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/AttachmentUploadDataResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/ciphers/{id}/attachment/{attachmentId}/renew": { | |
"get": { | |
"tags": [ | |
"Ciphers" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"name": "attachmentId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/AttachmentUploadDataResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/AttachmentUploadDataResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/AttachmentUploadDataResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/ciphers/{id}/attachment/{attachmentId}": { | |
"post": { | |
"tags": [ | |
"Ciphers" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"name": "attachmentId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
}, | |
"get": { | |
"tags": [ | |
"Ciphers" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"name": "attachmentId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/AttachmentResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/AttachmentResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/AttachmentResponseModel" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"delete": { | |
"tags": [ | |
"Ciphers" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"name": "attachmentId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/ciphers/{id}/attachment": { | |
"post": { | |
"tags": [ | |
"Ciphers" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherResponseModel" | |
} | |
} | |
} | |
} | |
}, | |
"deprecated": true | |
} | |
}, | |
"/ciphers/{id}/attachment-admin": { | |
"post": { | |
"tags": [ | |
"Ciphers" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherMiniResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherMiniResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CipherMiniResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/ciphers/{id}/attachment/{attachmentId}/share": { | |
"post": { | |
"tags": [ | |
"Ciphers" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"name": "attachmentId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"name": "organizationId", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/ciphers/{id}/attachment/{attachmentId}/delete": { | |
"post": { | |
"tags": [ | |
"Ciphers" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"name": "attachmentId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/ciphers/{id}/attachment/{attachmentId}/admin": { | |
"delete": { | |
"tags": [ | |
"Ciphers" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"name": "attachmentId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/ciphers/{id}/attachment/{attachmentId}/delete-admin": { | |
"post": { | |
"tags": [ | |
"Ciphers" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"name": "attachmentId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/ciphers/attachment/validate/azure": { | |
"post": { | |
"tags": [ | |
"Ciphers" | |
], | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/organizations/{orgId}/collections/{id}": { | |
"get": { | |
"tags": [ | |
"Collections" | |
], | |
"parameters": [ | |
{ | |
"name": "orgId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
}, | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/CollectionResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CollectionResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CollectionResponseModel" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"put": { | |
"tags": [ | |
"Collections" | |
], | |
"parameters": [ | |
{ | |
"name": "orgId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
}, | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CollectionRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CollectionRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/CollectionRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/CollectionResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CollectionResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CollectionResponseModel" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"post": { | |
"tags": [ | |
"Collections" | |
], | |
"parameters": [ | |
{ | |
"name": "orgId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
}, | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CollectionRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CollectionRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/CollectionRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/CollectionResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CollectionResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CollectionResponseModel" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"delete": { | |
"tags": [ | |
"Collections" | |
], | |
"parameters": [ | |
{ | |
"name": "orgId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
}, | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/organizations/{orgId}/collections/{id}/details": { | |
"get": { | |
"tags": [ | |
"Collections" | |
], | |
"parameters": [ | |
{ | |
"name": "orgId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
}, | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/CollectionGroupDetailsResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CollectionGroupDetailsResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CollectionGroupDetailsResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/organizations/{orgId}/collections": { | |
"get": { | |
"tags": [ | |
"Collections" | |
], | |
"parameters": [ | |
{ | |
"name": "orgId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/CollectionResponseModelListResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CollectionResponseModelListResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CollectionResponseModelListResponseModel" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"post": { | |
"tags": [ | |
"Collections" | |
], | |
"parameters": [ | |
{ | |
"name": "orgId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CollectionRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CollectionRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/CollectionRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/CollectionResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CollectionResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CollectionResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/collections": { | |
"get": { | |
"tags": [ | |
"Collections" | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/CollectionDetailsResponseModelListResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CollectionDetailsResponseModelListResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CollectionDetailsResponseModelListResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/organizations/{orgId}/collections/{id}/users": { | |
"get": { | |
"tags": [ | |
"Collections" | |
], | |
"parameters": [ | |
{ | |
"name": "orgId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
}, | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/SelectionReadOnlyResponseModel" | |
} | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/SelectionReadOnlyResponseModel" | |
} | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/SelectionReadOnlyResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"put": { | |
"tags": [ | |
"Collections" | |
], | |
"parameters": [ | |
{ | |
"name": "orgId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
}, | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/SelectionReadOnlyRequestModel" | |
} | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/SelectionReadOnlyRequestModel" | |
} | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/SelectionReadOnlyRequestModel" | |
} | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/organizations/{orgId}/collections/{id}/delete": { | |
"post": { | |
"tags": [ | |
"Collections" | |
], | |
"parameters": [ | |
{ | |
"name": "orgId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
}, | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/organizations/{orgId}/collections/{id}/user/{orgUserId}": { | |
"delete": { | |
"tags": [ | |
"Collections" | |
], | |
"parameters": [ | |
{ | |
"name": "orgId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"name": "orgUserId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/organizations/{orgId}/collections/{id}/delete-user/{orgUserId}": { | |
"post": { | |
"tags": [ | |
"Collections" | |
], | |
"parameters": [ | |
{ | |
"name": "orgId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"name": "orgUserId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/organizations/{orgId}/collections/ivy-test": { | |
"post": { | |
"tags": [ | |
"Collections" | |
], | |
"parameters": [ | |
{ | |
"name": "orgId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
}, | |
{ | |
"name": "collectionId", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"type": "boolean" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"type": "boolean" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"type": "boolean" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/devices/{id}": { | |
"get": { | |
"tags": [ | |
"Devices" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/DeviceResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/DeviceResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/DeviceResponseModel" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"put": { | |
"tags": [ | |
"Devices" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/DeviceRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/DeviceRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/DeviceRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/DeviceResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/DeviceResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/DeviceResponseModel" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"post": { | |
"tags": [ | |
"Devices" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/DeviceRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/DeviceRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/DeviceRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/DeviceResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/DeviceResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/DeviceResponseModel" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"delete": { | |
"tags": [ | |
"Devices" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/devices/identifier/{identifier}": { | |
"get": { | |
"tags": [ | |
"Devices" | |
], | |
"parameters": [ | |
{ | |
"name": "identifier", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/DeviceResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/DeviceResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/DeviceResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/devices": { | |
"get": { | |
"tags": [ | |
"Devices" | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/DeviceResponseModelListResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/DeviceResponseModelListResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/DeviceResponseModelListResponseModel" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"post": { | |
"tags": [ | |
"Devices" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/DeviceRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/DeviceRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/DeviceRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/DeviceResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/DeviceResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/DeviceResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/devices/identifier/{identifier}/token": { | |
"put": { | |
"tags": [ | |
"Devices" | |
], | |
"parameters": [ | |
{ | |
"name": "identifier", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/DeviceTokenRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/DeviceTokenRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/DeviceTokenRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
}, | |
"post": { | |
"tags": [ | |
"Devices" | |
], | |
"parameters": [ | |
{ | |
"name": "identifier", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/DeviceTokenRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/DeviceTokenRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/DeviceTokenRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/devices/identifier/{identifier}/clear-token": { | |
"put": { | |
"tags": [ | |
"Devices" | |
], | |
"parameters": [ | |
{ | |
"name": "identifier", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
}, | |
"post": { | |
"tags": [ | |
"Devices" | |
], | |
"parameters": [ | |
{ | |
"name": "identifier", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/devices/{id}/delete": { | |
"post": { | |
"tags": [ | |
"Devices" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/emergency-access/trusted": { | |
"get": { | |
"tags": [ | |
"EmergencyAccess" | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/EmergencyAccessGranteeDetailsResponseModelListResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/EmergencyAccessGranteeDetailsResponseModelListResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/EmergencyAccessGranteeDetailsResponseModelListResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/emergency-access/granted": { | |
"get": { | |
"tags": [ | |
"EmergencyAccess" | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/EmergencyAccessGrantorDetailsResponseModelListResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/EmergencyAccessGrantorDetailsResponseModelListResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/EmergencyAccessGrantorDetailsResponseModelListResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/emergency-access/{id}": { | |
"get": { | |
"tags": [ | |
"EmergencyAccess" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/EmergencyAccessGranteeDetailsResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/EmergencyAccessGranteeDetailsResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/EmergencyAccessGranteeDetailsResponseModel" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"put": { | |
"tags": [ | |
"EmergencyAccess" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/EmergencyAccessUpdateRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/EmergencyAccessUpdateRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/EmergencyAccessUpdateRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
}, | |
"post": { | |
"tags": [ | |
"EmergencyAccess" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/EmergencyAccessUpdateRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/EmergencyAccessUpdateRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/EmergencyAccessUpdateRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
}, | |
"delete": { | |
"tags": [ | |
"EmergencyAccess" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/emergency-access/{id}/policies": { | |
"get": { | |
"tags": [ | |
"EmergencyAccess" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/PolicyResponseModelListResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/PolicyResponseModelListResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/PolicyResponseModelListResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/emergency-access/{id}/delete": { | |
"post": { | |
"tags": [ | |
"EmergencyAccess" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/emergency-access/invite": { | |
"post": { | |
"tags": [ | |
"EmergencyAccess" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/EmergencyAccessInviteRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/EmergencyAccessInviteRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/EmergencyAccessInviteRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/emergency-access/{id}/reinvite": { | |
"post": { | |
"tags": [ | |
"EmergencyAccess" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/emergency-access/{id}/accept": { | |
"post": { | |
"tags": [ | |
"EmergencyAccess" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUserAcceptRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUserAcceptRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUserAcceptRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/emergency-access/{id}/confirm": { | |
"post": { | |
"tags": [ | |
"EmergencyAccess" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUserConfirmRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUserConfirmRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUserConfirmRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/emergency-access/{id}/initiate": { | |
"post": { | |
"tags": [ | |
"EmergencyAccess" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/emergency-access/{id}/approve": { | |
"post": { | |
"tags": [ | |
"EmergencyAccess" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/emergency-access/{id}/reject": { | |
"post": { | |
"tags": [ | |
"EmergencyAccess" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/emergency-access/{id}/takeover": { | |
"post": { | |
"tags": [ | |
"EmergencyAccess" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/EmergencyAccessTakeoverResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/EmergencyAccessTakeoverResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/EmergencyAccessTakeoverResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/emergency-access/{id}/password": { | |
"post": { | |
"tags": [ | |
"EmergencyAccess" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/EmergencyAccessPasswordRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/EmergencyAccessPasswordRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/EmergencyAccessPasswordRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/emergency-access/{id}/view": { | |
"post": { | |
"tags": [ | |
"EmergencyAccess" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/EmergencyAccessViewResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/EmergencyAccessViewResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/EmergencyAccessViewResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/emergency-access/{id}/{cipherId}/attachment/{attachmentId}": { | |
"get": { | |
"tags": [ | |
"EmergencyAccess" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
}, | |
{ | |
"name": "cipherId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
}, | |
{ | |
"name": "attachmentId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/AttachmentResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/AttachmentResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/AttachmentResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/events": { | |
"get": { | |
"tags": [ | |
"Events" | |
], | |
"parameters": [ | |
{ | |
"name": "start", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"format": "date-time" | |
} | |
}, | |
{ | |
"name": "end", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"format": "date-time" | |
} | |
}, | |
{ | |
"name": "continuationToken", | |
"in": "query", | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/EventResponseModelListResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/EventResponseModelListResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/EventResponseModelListResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/ciphers/{id}/events": { | |
"get": { | |
"tags": [ | |
"Events" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"name": "start", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"format": "date-time" | |
} | |
}, | |
{ | |
"name": "end", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"format": "date-time" | |
} | |
}, | |
{ | |
"name": "continuationToken", | |
"in": "query", | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/EventResponseModelListResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/EventResponseModelListResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/EventResponseModelListResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/organizations/{id}/events": { | |
"get": { | |
"tags": [ | |
"Events" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"name": "start", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"format": "date-time" | |
} | |
}, | |
{ | |
"name": "end", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"format": "date-time" | |
} | |
}, | |
{ | |
"name": "continuationToken", | |
"in": "query", | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/EventResponseModelListResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/EventResponseModelListResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/EventResponseModelListResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/organizations/{orgId}/users/{id}/events": { | |
"get": { | |
"tags": [ | |
"Events" | |
], | |
"parameters": [ | |
{ | |
"name": "orgId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"name": "start", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"format": "date-time" | |
} | |
}, | |
{ | |
"name": "end", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"format": "date-time" | |
} | |
}, | |
{ | |
"name": "continuationToken", | |
"in": "query", | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/EventResponseModelListResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/EventResponseModelListResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/EventResponseModelListResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/providers/{providerId}/events": { | |
"get": { | |
"tags": [ | |
"Events" | |
], | |
"parameters": [ | |
{ | |
"name": "providerId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
}, | |
{ | |
"name": "start", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"format": "date-time" | |
} | |
}, | |
{ | |
"name": "end", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"format": "date-time" | |
} | |
}, | |
{ | |
"name": "continuationToken", | |
"in": "query", | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/EventResponseModelListResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/EventResponseModelListResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/EventResponseModelListResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/providers/{providerId}/users/{id}/events": { | |
"get": { | |
"tags": [ | |
"Events" | |
], | |
"parameters": [ | |
{ | |
"name": "providerId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
}, | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
}, | |
{ | |
"name": "start", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"format": "date-time" | |
} | |
}, | |
{ | |
"name": "end", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"format": "date-time" | |
} | |
}, | |
{ | |
"name": "continuationToken", | |
"in": "query", | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/EventResponseModelListResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/EventResponseModelListResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/EventResponseModelListResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/folders/{id}": { | |
"get": { | |
"tags": [ | |
"Folders" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/FolderResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/FolderResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/FolderResponseModel" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"put": { | |
"tags": [ | |
"Folders" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/FolderRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/FolderRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/FolderRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/FolderResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/FolderResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/FolderResponseModel" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"post": { | |
"tags": [ | |
"Folders" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/FolderRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/FolderRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/FolderRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/FolderResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/FolderResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/FolderResponseModel" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"delete": { | |
"tags": [ | |
"Folders" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/folders": { | |
"get": { | |
"tags": [ | |
"Folders" | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/FolderResponseModelListResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/FolderResponseModelListResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/FolderResponseModelListResponseModel" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"post": { | |
"tags": [ | |
"Folders" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/FolderRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/FolderRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/FolderRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/FolderResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/FolderResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/FolderResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/folders/{id}/delete": { | |
"post": { | |
"tags": [ | |
"Folders" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/organizations/{orgId}/groups/{id}": { | |
"get": { | |
"tags": [ | |
"Groups" | |
], | |
"parameters": [ | |
{ | |
"name": "orgId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/GroupResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/GroupResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/GroupResponseModel" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"put": { | |
"tags": [ | |
"Groups" | |
], | |
"parameters": [ | |
{ | |
"name": "orgId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/GroupRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/GroupRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/GroupRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/GroupResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/GroupResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/GroupResponseModel" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"post": { | |
"tags": [ | |
"Groups" | |
], | |
"parameters": [ | |
{ | |
"name": "orgId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/GroupRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/GroupRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/GroupRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/GroupResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/GroupResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/GroupResponseModel" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"delete": { | |
"tags": [ | |
"Groups" | |
], | |
"parameters": [ | |
{ | |
"name": "orgId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/organizations/{orgId}/groups/{id}/details": { | |
"get": { | |
"tags": [ | |
"Groups" | |
], | |
"parameters": [ | |
{ | |
"name": "orgId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/GroupDetailsResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/GroupDetailsResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/GroupDetailsResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/organizations/{orgId}/groups": { | |
"get": { | |
"tags": [ | |
"Groups" | |
], | |
"parameters": [ | |
{ | |
"name": "orgId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/GroupResponseModelListResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/GroupResponseModelListResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/GroupResponseModelListResponseModel" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"post": { | |
"tags": [ | |
"Groups" | |
], | |
"parameters": [ | |
{ | |
"name": "orgId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/GroupRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/GroupRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/GroupRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/GroupResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/GroupResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/GroupResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/organizations/{orgId}/groups/{id}/users": { | |
"get": { | |
"tags": [ | |
"Groups" | |
], | |
"parameters": [ | |
{ | |
"name": "orgId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"format": "uuid" | |
} | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"format": "uuid" | |
} | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"format": "uuid" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"put": { | |
"tags": [ | |
"Groups" | |
], | |
"parameters": [ | |
{ | |
"name": "orgId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"format": "uuid" | |
} | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"format": "uuid" | |
} | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"format": "uuid" | |
} | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/organizations/{orgId}/groups/{id}/delete": { | |
"post": { | |
"tags": [ | |
"Groups" | |
], | |
"parameters": [ | |
{ | |
"name": "orgId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/organizations/{orgId}/groups/{id}/user/{orgUserId}": { | |
"delete": { | |
"tags": [ | |
"Groups" | |
], | |
"parameters": [ | |
{ | |
"name": "orgId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"name": "orgUserId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/organizations/{orgId}/groups/{id}/delete-user/{orgUserId}": { | |
"post": { | |
"tags": [ | |
"Groups" | |
], | |
"parameters": [ | |
{ | |
"name": "orgId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"name": "orgUserId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/hibp/breach": { | |
"get": { | |
"tags": [ | |
"Hibp" | |
], | |
"parameters": [ | |
{ | |
"name": "username", | |
"in": "query", | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/alive": { | |
"get": { | |
"tags": [ | |
"Info" | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"type": "string", | |
"format": "date-time" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"type": "string", | |
"format": "date-time" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"type": "string", | |
"format": "date-time" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/now": { | |
"get": { | |
"tags": [ | |
"Info" | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"type": "string", | |
"format": "date-time" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"type": "string", | |
"format": "date-time" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"type": "string", | |
"format": "date-time" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/version": { | |
"get": { | |
"tags": [ | |
"Info" | |
], | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/ip": { | |
"get": { | |
"tags": [ | |
"Info" | |
], | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/installations/{id}": { | |
"get": { | |
"tags": [ | |
"Installations" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/InstallationResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/InstallationResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/InstallationResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/installations": { | |
"post": { | |
"tags": [ | |
"Installations" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/InstallationRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/InstallationRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/InstallationRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/InstallationResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/InstallationResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/InstallationResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/licenses/user/{id}": { | |
"get": { | |
"tags": [ | |
"Licenses" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"name": "key", | |
"in": "query", | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/UserLicense" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/UserLicense" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/UserLicense" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/licenses/organization/{id}": { | |
"get": { | |
"tags": [ | |
"Licenses" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"name": "key", | |
"in": "query", | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationLicense" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationLicense" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationLicense" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/bitpay-invoice": { | |
"post": { | |
"tags": [ | |
"Misc" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/BitPayInvoiceRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/BitPayInvoiceRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/BitPayInvoiceRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"type": "string" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"type": "string" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/setup-payment": { | |
"post": { | |
"tags": [ | |
"Misc" | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"type": "string" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"type": "string" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/organizations/connections/enabled": { | |
"get": { | |
"tags": [ | |
"OrganizationConnections" | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"type": "boolean" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"type": "boolean" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"type": "boolean" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/organizations/connections": { | |
"post": { | |
"tags": [ | |
"OrganizationConnections" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationConnectionRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationConnectionRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationConnectionRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationConnectionResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationConnectionResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationConnectionResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/organizations/connections/{organizationConnectionId}": { | |
"put": { | |
"tags": [ | |
"OrganizationConnections" | |
], | |
"parameters": [ | |
{ | |
"name": "organizationConnectionId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationConnectionRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationConnectionRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationConnectionRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationConnectionResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationConnectionResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationConnectionResponseModel" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"delete": { | |
"tags": [ | |
"OrganizationConnections" | |
], | |
"parameters": [ | |
{ | |
"name": "organizationConnectionId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/organizations/connections/{organizationId}/{type}": { | |
"get": { | |
"tags": [ | |
"OrganizationConnections" | |
], | |
"parameters": [ | |
{ | |
"name": "organizationId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
}, | |
{ | |
"name": "type", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationConnectionType" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationConnectionResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationConnectionResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationConnectionResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/organizations/connections/{organizationConnectionId}/delete": { | |
"post": { | |
"tags": [ | |
"OrganizationConnections" | |
], | |
"parameters": [ | |
{ | |
"name": "organizationConnectionId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/organizations/{id}": { | |
"get": { | |
"tags": [ | |
"Organizations" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationResponseModel" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"put": { | |
"tags": [ | |
"Organizations" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUpdateRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUpdateRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUpdateRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationResponseModel" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"post": { | |
"tags": [ | |
"Organizations" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUpdateRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUpdateRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUpdateRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationResponseModel" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"delete": { | |
"tags": [ | |
"Organizations" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/SecretVerificationRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/SecretVerificationRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/SecretVerificationRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/organizations/{id}/billing": { | |
"get": { | |
"tags": [ | |
"Organizations" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/BillingResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/BillingResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/BillingResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/organizations/{id}/subscription": { | |
"get": { | |
"tags": [ | |
"Organizations" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationSubscriptionResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationSubscriptionResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationSubscriptionResponseModel" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"post": { | |
"tags": [ | |
"Organizations" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationSubscriptionUpdateRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationSubscriptionUpdateRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationSubscriptionUpdateRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/organizations/{id}/license": { | |
"get": { | |
"tags": [ | |
"Organizations" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"name": "installationId", | |
"in": "query", | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationLicense" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationLicense" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationLicense" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"post": { | |
"tags": [ | |
"Organizations" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"multipart/form-data": { | |
"schema": { | |
"required": [ | |
"license" | |
], | |
"type": "object", | |
"properties": { | |
"license": { | |
"type": "string", | |
"format": "binary" | |
} | |
} | |
}, | |
"encoding": { | |
"license": { | |
"style": "form" | |
} | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/organizations": { | |
"get": { | |
"tags": [ | |
"Organizations" | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/ProfileOrganizationResponseModelListResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ProfileOrganizationResponseModelListResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ProfileOrganizationResponseModelListResponseModel" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"post": { | |
"tags": [ | |
"Organizations" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationCreateRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationCreateRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationCreateRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/organizations/{identifier}/auto-enroll-status": { | |
"get": { | |
"tags": [ | |
"Organizations" | |
], | |
"parameters": [ | |
{ | |
"name": "identifier", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationAutoEnrollStatusResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationAutoEnrollStatusResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationAutoEnrollStatusResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/organizations/license": { | |
"post": { | |
"tags": [ | |
"Organizations" | |
], | |
"parameters": [ | |
{ | |
"name": "key", | |
"in": "query", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"name": "collectionName", | |
"in": "query", | |
"schema": { | |
"maxLength": 1000, | |
"minLength": 0, | |
"type": "string" | |
} | |
}, | |
{ | |
"name": "keys.publicKey", | |
"in": "query", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"name": "keys.encryptedPrivateKey", | |
"in": "query", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"multipart/form-data": { | |
"schema": { | |
"required": [ | |
"license" | |
], | |
"type": "object", | |
"properties": { | |
"license": { | |
"type": "string", | |
"format": "binary" | |
} | |
} | |
}, | |
"encoding": { | |
"license": { | |
"style": "form" | |
} | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/organizations/{id}/payment": { | |
"post": { | |
"tags": [ | |
"Organizations" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/PaymentRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/PaymentRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/PaymentRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/organizations/{id}/upgrade": { | |
"post": { | |
"tags": [ | |
"Organizations" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUpgradeRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUpgradeRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUpgradeRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/PaymentResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/PaymentResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/PaymentResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/organizations/{id}/seat": { | |
"post": { | |
"tags": [ | |
"Organizations" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationSeatRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationSeatRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationSeatRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/PaymentResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/PaymentResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/PaymentResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/organizations/{id}/storage": { | |
"post": { | |
"tags": [ | |
"Organizations" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/StorageRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/StorageRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/StorageRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/PaymentResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/PaymentResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/PaymentResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/organizations/{id}/verify-bank": { | |
"post": { | |
"tags": [ | |
"Organizations" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationVerifyBankRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationVerifyBankRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationVerifyBankRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/organizations/{id}/cancel": { | |
"post": { | |
"tags": [ | |
"Organizations" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/organizations/{id}/reinstate": { | |
"post": { | |
"tags": [ | |
"Organizations" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/organizations/{id}/leave": { | |
"post": { | |
"tags": [ | |
"Organizations" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/organizations/{id}/delete": { | |
"post": { | |
"tags": [ | |
"Organizations" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/SecretVerificationRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/SecretVerificationRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/SecretVerificationRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/organizations/{id}/import": { | |
"post": { | |
"tags": [ | |
"Organizations" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ImportOrganizationUsersRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ImportOrganizationUsersRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/ImportOrganizationUsersRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/organizations/{id}/api-key": { | |
"post": { | |
"tags": [ | |
"Organizations" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationApiKeyRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationApiKeyRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationApiKeyRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiKeyResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiKeyResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiKeyResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/organizations/{id}/api-key-information": { | |
"get": { | |
"tags": [ | |
"Organizations" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationApiKeyInformationListResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationApiKeyInformationListResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationApiKeyInformationListResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/organizations/{id}/rotate-api-key": { | |
"post": { | |
"tags": [ | |
"Organizations" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationApiKeyRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationApiKeyRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationApiKeyRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiKeyResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiKeyResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ApiKeyResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/organizations/{id}/tax": { | |
"get": { | |
"tags": [ | |
"Organizations" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/TaxInfoResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/TaxInfoResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/TaxInfoResponseModel" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"put": { | |
"tags": [ | |
"Organizations" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationTaxInfoUpdateRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationTaxInfoUpdateRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationTaxInfoUpdateRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/organizations/{id}/keys": { | |
"get": { | |
"tags": [ | |
"Organizations" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationKeysResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationKeysResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationKeysResponseModel" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"post": { | |
"tags": [ | |
"Organizations" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationKeysRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationKeysRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationKeysRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationKeysResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationKeysResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationKeysResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/organizations/{id}/sso": { | |
"get": { | |
"tags": [ | |
"Organizations" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationSsoResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationSsoResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationSsoResponseModel" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"post": { | |
"tags": [ | |
"Organizations" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationSsoRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationSsoRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationSsoRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationSsoResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationSsoResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationSsoResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/organization/sponsorship/{sponsoringOrgId}/families-for-enterprise": { | |
"post": { | |
"tags": [ | |
"OrganizationSponsorships" | |
], | |
"parameters": [ | |
{ | |
"name": "sponsoringOrgId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationSponsorshipCreateRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationSponsorshipCreateRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationSponsorshipCreateRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/organization/sponsorship/{sponsoringOrgId}/families-for-enterprise/resend": { | |
"post": { | |
"tags": [ | |
"OrganizationSponsorships" | |
], | |
"parameters": [ | |
{ | |
"name": "sponsoringOrgId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/organization/sponsorship/validate-token": { | |
"post": { | |
"tags": [ | |
"OrganizationSponsorships" | |
], | |
"parameters": [ | |
{ | |
"name": "sponsorshipToken", | |
"in": "query", | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"type": "boolean" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"type": "boolean" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"type": "boolean" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/organization/sponsorship/redeem": { | |
"post": { | |
"tags": [ | |
"OrganizationSponsorships" | |
], | |
"parameters": [ | |
{ | |
"name": "sponsorshipToken", | |
"in": "query", | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationSponsorshipRedeemRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationSponsorshipRedeemRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationSponsorshipRedeemRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/organization/sponsorship/sync": { | |
"post": { | |
"tags": [ | |
"OrganizationSponsorships" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationSponsorshipSyncRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationSponsorshipSyncRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationSponsorshipSyncRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationSponsorshipSyncResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationSponsorshipSyncResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationSponsorshipSyncResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/organization/sponsorship/{sponsoringOrganizationId}": { | |
"delete": { | |
"tags": [ | |
"OrganizationSponsorships" | |
], | |
"parameters": [ | |
{ | |
"name": "sponsoringOrganizationId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/organization/sponsorship/{sponsoringOrganizationId}/delete": { | |
"post": { | |
"tags": [ | |
"OrganizationSponsorships" | |
], | |
"parameters": [ | |
{ | |
"name": "sponsoringOrganizationId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/organization/sponsorship/sponsored/{sponsoredOrgId}": { | |
"delete": { | |
"tags": [ | |
"OrganizationSponsorships" | |
], | |
"parameters": [ | |
{ | |
"name": "sponsoredOrgId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/organization/sponsorship/sponsored/{sponsoredOrgId}/remove": { | |
"post": { | |
"tags": [ | |
"OrganizationSponsorships" | |
], | |
"parameters": [ | |
{ | |
"name": "sponsoredOrgId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/organization/sponsorship/{sponsoringOrgId}/sync-status": { | |
"get": { | |
"tags": [ | |
"OrganizationSponsorships" | |
], | |
"parameters": [ | |
{ | |
"name": "sponsoringOrgId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/organizations/{orgId}/users/{id}": { | |
"get": { | |
"tags": [ | |
"OrganizationUsers" | |
], | |
"parameters": [ | |
{ | |
"name": "orgId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUserDetailsResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUserDetailsResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUserDetailsResponseModel" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"put": { | |
"tags": [ | |
"OrganizationUsers" | |
], | |
"parameters": [ | |
{ | |
"name": "orgId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUserUpdateRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUserUpdateRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUserUpdateRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
}, | |
"post": { | |
"tags": [ | |
"OrganizationUsers" | |
], | |
"parameters": [ | |
{ | |
"name": "orgId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUserUpdateRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUserUpdateRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUserUpdateRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
}, | |
"delete": { | |
"tags": [ | |
"OrganizationUsers" | |
], | |
"parameters": [ | |
{ | |
"name": "orgId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/organizations/{orgId}/users": { | |
"get": { | |
"tags": [ | |
"OrganizationUsers" | |
], | |
"parameters": [ | |
{ | |
"name": "orgId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUserUserDetailsResponseModelListResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUserUserDetailsResponseModelListResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUserUserDetailsResponseModelListResponseModel" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"delete": { | |
"tags": [ | |
"OrganizationUsers" | |
], | |
"parameters": [ | |
{ | |
"name": "orgId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUserBulkRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUserBulkRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUserBulkRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUserBulkResponseModelListResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUserBulkResponseModelListResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUserBulkResponseModelListResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/organizations/{orgId}/users/{id}/groups": { | |
"get": { | |
"tags": [ | |
"OrganizationUsers" | |
], | |
"parameters": [ | |
{ | |
"name": "orgId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"put": { | |
"tags": [ | |
"OrganizationUsers" | |
], | |
"parameters": [ | |
{ | |
"name": "orgId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUserUpdateGroupsRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUserUpdateGroupsRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUserUpdateGroupsRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
}, | |
"post": { | |
"tags": [ | |
"OrganizationUsers" | |
], | |
"parameters": [ | |
{ | |
"name": "orgId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUserUpdateGroupsRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUserUpdateGroupsRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUserUpdateGroupsRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/organizations/{orgId}/users/{id}/reset-password-details": { | |
"get": { | |
"tags": [ | |
"OrganizationUsers" | |
], | |
"parameters": [ | |
{ | |
"name": "orgId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUserResetPasswordDetailsResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUserResetPasswordDetailsResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUserResetPasswordDetailsResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/organizations/{orgId}/users/invite": { | |
"post": { | |
"tags": [ | |
"OrganizationUsers" | |
], | |
"parameters": [ | |
{ | |
"name": "orgId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUserInviteRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUserInviteRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUserInviteRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/organizations/{orgId}/users/reinvite": { | |
"post": { | |
"tags": [ | |
"OrganizationUsers" | |
], | |
"parameters": [ | |
{ | |
"name": "orgId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUserBulkRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUserBulkRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUserBulkRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUserBulkResponseModelListResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUserBulkResponseModelListResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUserBulkResponseModelListResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/organizations/{orgId}/users/{id}/reinvite": { | |
"post": { | |
"tags": [ | |
"OrganizationUsers" | |
], | |
"parameters": [ | |
{ | |
"name": "orgId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/organizations/{orgId}/users/{organizationUserId}/accept": { | |
"post": { | |
"tags": [ | |
"OrganizationUsers" | |
], | |
"parameters": [ | |
{ | |
"name": "orgId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
}, | |
{ | |
"name": "organizationUserId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUserAcceptRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUserAcceptRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUserAcceptRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/organizations/{orgId}/users/{id}/confirm": { | |
"post": { | |
"tags": [ | |
"OrganizationUsers" | |
], | |
"parameters": [ | |
{ | |
"name": "orgId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUserConfirmRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUserConfirmRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUserConfirmRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/organizations/{orgId}/users/confirm": { | |
"post": { | |
"tags": [ | |
"OrganizationUsers" | |
], | |
"parameters": [ | |
{ | |
"name": "orgId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUserBulkConfirmRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUserBulkConfirmRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUserBulkConfirmRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUserBulkResponseModelListResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUserBulkResponseModelListResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUserBulkResponseModelListResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/organizations/{orgId}/users/public-keys": { | |
"post": { | |
"tags": [ | |
"OrganizationUsers" | |
], | |
"parameters": [ | |
{ | |
"name": "orgId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUserBulkRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUserBulkRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUserBulkRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUserPublicKeyResponseModelListResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUserPublicKeyResponseModelListResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUserPublicKeyResponseModelListResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/organizations/{orgId}/users/{userId}/reset-password-enrollment": { | |
"put": { | |
"tags": [ | |
"OrganizationUsers" | |
], | |
"parameters": [ | |
{ | |
"name": "orgId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"name": "userId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUserResetPasswordEnrollmentRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUserResetPasswordEnrollmentRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUserResetPasswordEnrollmentRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/organizations/{orgId}/users/{id}/reset-password": { | |
"put": { | |
"tags": [ | |
"OrganizationUsers" | |
], | |
"parameters": [ | |
{ | |
"name": "orgId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUserResetPasswordRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUserResetPasswordRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUserResetPasswordRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/organizations/{orgId}/users/{id}/delete": { | |
"post": { | |
"tags": [ | |
"OrganizationUsers" | |
], | |
"parameters": [ | |
{ | |
"name": "orgId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/organizations/{orgId}/users/delete": { | |
"post": { | |
"tags": [ | |
"OrganizationUsers" | |
], | |
"parameters": [ | |
{ | |
"name": "orgId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUserBulkRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUserBulkRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUserBulkRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUserBulkResponseModelListResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUserBulkResponseModelListResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUserBulkResponseModelListResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/organizations/{orgId}/users/{id}/deactivate": { | |
"patch": { | |
"tags": [ | |
"OrganizationUsers" | |
], | |
"parameters": [ | |
{ | |
"name": "orgId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
}, | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
}, | |
"put": { | |
"tags": [ | |
"OrganizationUsers" | |
], | |
"parameters": [ | |
{ | |
"name": "orgId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
}, | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/organizations/{orgId}/users/deactivate": { | |
"patch": { | |
"tags": [ | |
"OrganizationUsers" | |
], | |
"parameters": [ | |
{ | |
"name": "orgId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUserBulkRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUserBulkRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUserBulkRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUserBulkResponseModelListResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUserBulkResponseModelListResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUserBulkResponseModelListResponseModel" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"put": { | |
"tags": [ | |
"OrganizationUsers" | |
], | |
"parameters": [ | |
{ | |
"name": "orgId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUserBulkRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUserBulkRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUserBulkRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUserBulkResponseModelListResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUserBulkResponseModelListResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUserBulkResponseModelListResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/organizations/{orgId}/users/{id}/activate": { | |
"patch": { | |
"tags": [ | |
"OrganizationUsers" | |
], | |
"parameters": [ | |
{ | |
"name": "orgId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
}, | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
}, | |
"put": { | |
"tags": [ | |
"OrganizationUsers" | |
], | |
"parameters": [ | |
{ | |
"name": "orgId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
}, | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/organizations/{orgId}/users/activate": { | |
"patch": { | |
"tags": [ | |
"OrganizationUsers" | |
], | |
"parameters": [ | |
{ | |
"name": "orgId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUserBulkRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUserBulkRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUserBulkRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUserBulkResponseModelListResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUserBulkResponseModelListResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUserBulkResponseModelListResponseModel" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"put": { | |
"tags": [ | |
"OrganizationUsers" | |
], | |
"parameters": [ | |
{ | |
"name": "orgId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUserBulkRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUserBulkRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUserBulkRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUserBulkResponseModelListResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUserBulkResponseModelListResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationUserBulkResponseModelListResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/plans": { | |
"get": { | |
"tags": [ | |
"Plans" | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/PlanResponseModelListResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/PlanResponseModelListResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/PlanResponseModelListResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/plans/sales-tax-rates": { | |
"get": { | |
"tags": [ | |
"Plans" | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/TaxRateResponseModelListResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/TaxRateResponseModelListResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/TaxRateResponseModelListResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/organizations/{orgId}/policies/{type}": { | |
"get": { | |
"tags": [ | |
"Policies" | |
], | |
"parameters": [ | |
{ | |
"name": "orgId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"name": "type", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "integer", | |
"format": "int32" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/PolicyResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/PolicyResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/PolicyResponseModel" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"put": { | |
"tags": [ | |
"Policies" | |
], | |
"parameters": [ | |
{ | |
"name": "orgId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"name": "type", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "integer", | |
"format": "int32" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/PolicyRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/PolicyRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/PolicyRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/PolicyResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/PolicyResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/PolicyResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/organizations/{orgId}/policies": { | |
"get": { | |
"tags": [ | |
"Policies" | |
], | |
"parameters": [ | |
{ | |
"name": "orgId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/PolicyResponseModelListResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/PolicyResponseModelListResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/PolicyResponseModelListResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/organizations/{orgId}/policies/token": { | |
"get": { | |
"tags": [ | |
"Policies" | |
], | |
"parameters": [ | |
{ | |
"name": "orgId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"name": "email", | |
"in": "query", | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"name": "token", | |
"in": "query", | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"name": "organizationUserId", | |
"in": "query", | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/PolicyResponseModelListResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/PolicyResponseModelListResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/PolicyResponseModelListResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/organizations/{orgId}/policies/invited-user": { | |
"get": { | |
"tags": [ | |
"Policies" | |
], | |
"parameters": [ | |
{ | |
"name": "orgId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"name": "userId", | |
"in": "query", | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/PolicyResponseModelListResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/PolicyResponseModelListResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/PolicyResponseModelListResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/providers/{providerId}/organizations": { | |
"get": { | |
"tags": [ | |
"ProviderOrganizations" | |
], | |
"parameters": [ | |
{ | |
"name": "providerId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/ProviderOrganizationOrganizationDetailsResponseModelListResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ProviderOrganizationOrganizationDetailsResponseModelListResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ProviderOrganizationOrganizationDetailsResponseModelListResponseModel" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"post": { | |
"tags": [ | |
"ProviderOrganizations" | |
], | |
"parameters": [ | |
{ | |
"name": "providerId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ProviderOrganizationCreateRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ProviderOrganizationCreateRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/ProviderOrganizationCreateRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/ProviderOrganizationResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ProviderOrganizationResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ProviderOrganizationResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/providers/{providerId}/organizations/add": { | |
"post": { | |
"tags": [ | |
"ProviderOrganizations" | |
], | |
"parameters": [ | |
{ | |
"name": "providerId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ProviderOrganizationAddRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ProviderOrganizationAddRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/ProviderOrganizationAddRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/providers/{providerId}/organizations/{id}": { | |
"delete": { | |
"tags": [ | |
"ProviderOrganizations" | |
], | |
"parameters": [ | |
{ | |
"name": "providerId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
}, | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/providers/{providerId}/organizations/{id}/delete": { | |
"post": { | |
"tags": [ | |
"ProviderOrganizations" | |
], | |
"parameters": [ | |
{ | |
"name": "providerId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
}, | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/providers/{id}": { | |
"get": { | |
"tags": [ | |
"Providers" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/ProviderResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ProviderResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ProviderResponseModel" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"put": { | |
"tags": [ | |
"Providers" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ProviderUpdateRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ProviderUpdateRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/ProviderUpdateRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/ProviderResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ProviderResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ProviderResponseModel" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"post": { | |
"tags": [ | |
"Providers" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ProviderUpdateRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ProviderUpdateRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/ProviderUpdateRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/ProviderResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ProviderResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ProviderResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/providers/{id}/setup": { | |
"post": { | |
"tags": [ | |
"Providers" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ProviderSetupRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ProviderSetupRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/ProviderSetupRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/ProviderResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ProviderResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ProviderResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/providers/{providerId}/users/{id}": { | |
"get": { | |
"tags": [ | |
"ProviderUsers" | |
], | |
"parameters": [ | |
{ | |
"name": "providerId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
}, | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/ProviderUserResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ProviderUserResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ProviderUserResponseModel" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"put": { | |
"tags": [ | |
"ProviderUsers" | |
], | |
"parameters": [ | |
{ | |
"name": "providerId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
}, | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ProviderUserUpdateRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ProviderUserUpdateRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/ProviderUserUpdateRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
}, | |
"post": { | |
"tags": [ | |
"ProviderUsers" | |
], | |
"parameters": [ | |
{ | |
"name": "providerId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
}, | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ProviderUserUpdateRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ProviderUserUpdateRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/ProviderUserUpdateRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
}, | |
"delete": { | |
"tags": [ | |
"ProviderUsers" | |
], | |
"parameters": [ | |
{ | |
"name": "providerId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
}, | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/providers/{providerId}/users": { | |
"get": { | |
"tags": [ | |
"ProviderUsers" | |
], | |
"parameters": [ | |
{ | |
"name": "providerId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/ProviderUserUserDetailsResponseModelListResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ProviderUserUserDetailsResponseModelListResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ProviderUserUserDetailsResponseModelListResponseModel" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"delete": { | |
"tags": [ | |
"ProviderUsers" | |
], | |
"parameters": [ | |
{ | |
"name": "providerId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ProviderUserBulkRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ProviderUserBulkRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/ProviderUserBulkRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/ProviderUserBulkResponseModelListResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ProviderUserBulkResponseModelListResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ProviderUserBulkResponseModelListResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/providers/{providerId}/users/invite": { | |
"post": { | |
"tags": [ | |
"ProviderUsers" | |
], | |
"parameters": [ | |
{ | |
"name": "providerId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ProviderUserInviteRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ProviderUserInviteRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/ProviderUserInviteRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/providers/{providerId}/users/reinvite": { | |
"post": { | |
"tags": [ | |
"ProviderUsers" | |
], | |
"parameters": [ | |
{ | |
"name": "providerId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ProviderUserBulkRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ProviderUserBulkRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/ProviderUserBulkRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/ProviderUserBulkResponseModelListResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ProviderUserBulkResponseModelListResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ProviderUserBulkResponseModelListResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/providers/{providerId}/users/{id}/reinvite": { | |
"post": { | |
"tags": [ | |
"ProviderUsers" | |
], | |
"parameters": [ | |
{ | |
"name": "providerId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
}, | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/providers/{providerId}/users/{id}/accept": { | |
"post": { | |
"tags": [ | |
"ProviderUsers" | |
], | |
"parameters": [ | |
{ | |
"name": "providerId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
}, | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ProviderUserAcceptRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ProviderUserAcceptRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/ProviderUserAcceptRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/providers/{providerId}/users/{id}/confirm": { | |
"post": { | |
"tags": [ | |
"ProviderUsers" | |
], | |
"parameters": [ | |
{ | |
"name": "providerId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
}, | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ProviderUserConfirmRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ProviderUserConfirmRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/ProviderUserConfirmRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/providers/{providerId}/users/confirm": { | |
"post": { | |
"tags": [ | |
"ProviderUsers" | |
], | |
"parameters": [ | |
{ | |
"name": "providerId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ProviderUserBulkConfirmRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ProviderUserBulkConfirmRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/ProviderUserBulkConfirmRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/ProviderUserBulkResponseModelListResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ProviderUserBulkResponseModelListResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ProviderUserBulkResponseModelListResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/providers/{providerId}/users/public-keys": { | |
"post": { | |
"tags": [ | |
"ProviderUsers" | |
], | |
"parameters": [ | |
{ | |
"name": "providerId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ProviderUserBulkRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ProviderUserBulkRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/ProviderUserBulkRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/ProviderUserPublicKeyResponseModelListResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ProviderUserPublicKeyResponseModelListResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ProviderUserPublicKeyResponseModelListResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/providers/{providerId}/users/{id}/delete": { | |
"post": { | |
"tags": [ | |
"ProviderUsers" | |
], | |
"parameters": [ | |
{ | |
"name": "providerId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
}, | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/providers/{providerId}/users/delete": { | |
"post": { | |
"tags": [ | |
"ProviderUsers" | |
], | |
"parameters": [ | |
{ | |
"name": "providerId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ProviderUserBulkRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ProviderUserBulkRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/ProviderUserBulkRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/ProviderUserBulkResponseModelListResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ProviderUserBulkResponseModelListResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/ProviderUserBulkResponseModelListResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/push/register": { | |
"post": { | |
"tags": [ | |
"Push" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/PushRegistrationRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/PushRegistrationRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/PushRegistrationRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/push/{id}": { | |
"delete": { | |
"tags": [ | |
"Push" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/push/add-organization": { | |
"put": { | |
"tags": [ | |
"Push" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/PushUpdateRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/PushUpdateRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/PushUpdateRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/push/delete-organization": { | |
"put": { | |
"tags": [ | |
"Push" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/PushUpdateRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/PushUpdateRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/PushUpdateRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/push/send": { | |
"post": { | |
"tags": [ | |
"Push" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/PushSendRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/PushSendRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/PushSendRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/organization/sponsorship/self-hosted/{sponsoringOrgId}/families-for-enterprise": { | |
"post": { | |
"tags": [ | |
"SelfHostedOrganizationSponsorships" | |
], | |
"parameters": [ | |
{ | |
"name": "sponsoringOrgId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationSponsorshipCreateRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationSponsorshipCreateRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/OrganizationSponsorshipCreateRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/organization/sponsorship/self-hosted/{sponsoringOrgId}": { | |
"delete": { | |
"tags": [ | |
"SelfHostedOrganizationSponsorships" | |
], | |
"parameters": [ | |
{ | |
"name": "sponsoringOrgId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/organization/sponsorship/self-hosted/{sponsoringOrgId}/delete": { | |
"post": { | |
"tags": [ | |
"SelfHostedOrganizationSponsorships" | |
], | |
"parameters": [ | |
{ | |
"name": "sponsoringOrgId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string", | |
"format": "uuid" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/sends/access/{id}": { | |
"post": { | |
"tags": [ | |
"Sends" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/SendAccessRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/SendAccessRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/SendAccessRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/sends/{encodedSendId}/access/file/{fileId}": { | |
"post": { | |
"tags": [ | |
"Sends" | |
], | |
"parameters": [ | |
{ | |
"name": "encodedSendId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"name": "fileId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/SendAccessRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/SendAccessRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/SendAccessRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/sends/{id}": { | |
"get": { | |
"tags": [ | |
"Sends" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/SendResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/SendResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/SendResponseModel" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"put": { | |
"tags": [ | |
"Sends" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/SendRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/SendRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/SendRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/SendResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/SendResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/SendResponseModel" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"delete": { | |
"tags": [ | |
"Sends" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/sends": { | |
"get": { | |
"tags": [ | |
"Sends" | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/SendResponseModelListResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/SendResponseModelListResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/SendResponseModelListResponseModel" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"post": { | |
"tags": [ | |
"Sends" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/SendRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/SendRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/SendRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/SendResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/SendResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/SendResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/sends/file": { | |
"post": { | |
"tags": [ | |
"Sends" | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/SendResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/SendResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/SendResponseModel" | |
} | |
} | |
} | |
} | |
}, | |
"deprecated": true | |
} | |
}, | |
"/sends/file/v2": { | |
"post": { | |
"tags": [ | |
"Sends" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/SendRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/SendRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/SendRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/SendFileUploadDataResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/SendFileUploadDataResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/SendFileUploadDataResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/sends/{id}/file/{fileId}": { | |
"get": { | |
"tags": [ | |
"Sends" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"name": "fileId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/SendFileUploadDataResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/SendFileUploadDataResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/SendFileUploadDataResponseModel" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"post": { | |
"tags": [ | |
"Sends" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
}, | |
{ | |
"name": "fileId", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/sends/file/validate/azure": { | |
"post": { | |
"tags": [ | |
"Sends" | |
], | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/sends/{id}/remove-password": { | |
"put": { | |
"tags": [ | |
"Sends" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/SendResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/SendResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/SendResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/settings/domains": { | |
"get": { | |
"tags": [ | |
"Settings" | |
], | |
"parameters": [ | |
{ | |
"name": "excluded", | |
"in": "query", | |
"schema": { | |
"type": "boolean", | |
"default": true | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/DomainsResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/DomainsResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/DomainsResponseModel" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"put": { | |
"tags": [ | |
"Settings" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/UpdateDomainsRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/UpdateDomainsRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/UpdateDomainsRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/DomainsResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/DomainsResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/DomainsResponseModel" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"post": { | |
"tags": [ | |
"Settings" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/UpdateDomainsRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/UpdateDomainsRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/UpdateDomainsRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/DomainsResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/DomainsResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/DomainsResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/sync": { | |
"get": { | |
"tags": [ | |
"Sync" | |
], | |
"parameters": [ | |
{ | |
"name": "excludeDomains", | |
"in": "query", | |
"schema": { | |
"type": "boolean", | |
"default": false | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/SyncResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/SyncResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/SyncResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/two-factor": { | |
"get": { | |
"tags": [ | |
"TwoFactor" | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorProviderResponseModelListResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorProviderResponseModelListResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorProviderResponseModelListResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/organizations/{id}/two-factor": { | |
"get": { | |
"tags": [ | |
"TwoFactor" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorProviderResponseModelListResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorProviderResponseModelListResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorProviderResponseModelListResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/two-factor/get-authenticator": { | |
"post": { | |
"tags": [ | |
"TwoFactor" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/SecretVerificationRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/SecretVerificationRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/SecretVerificationRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorAuthenticatorResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorAuthenticatorResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorAuthenticatorResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/two-factor/authenticator": { | |
"put": { | |
"tags": [ | |
"TwoFactor" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/UpdateTwoFactorAuthenticatorRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/UpdateTwoFactorAuthenticatorRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/UpdateTwoFactorAuthenticatorRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorAuthenticatorResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorAuthenticatorResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorAuthenticatorResponseModel" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"post": { | |
"tags": [ | |
"TwoFactor" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/UpdateTwoFactorAuthenticatorRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/UpdateTwoFactorAuthenticatorRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/UpdateTwoFactorAuthenticatorRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorAuthenticatorResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorAuthenticatorResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorAuthenticatorResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/two-factor/get-yubikey": { | |
"post": { | |
"tags": [ | |
"TwoFactor" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/SecretVerificationRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/SecretVerificationRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/SecretVerificationRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorYubiKeyResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorYubiKeyResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorYubiKeyResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/two-factor/yubikey": { | |
"put": { | |
"tags": [ | |
"TwoFactor" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/UpdateTwoFactorYubicoOtpRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/UpdateTwoFactorYubicoOtpRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/UpdateTwoFactorYubicoOtpRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorYubiKeyResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorYubiKeyResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorYubiKeyResponseModel" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"post": { | |
"tags": [ | |
"TwoFactor" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/UpdateTwoFactorYubicoOtpRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/UpdateTwoFactorYubicoOtpRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/UpdateTwoFactorYubicoOtpRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorYubiKeyResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorYubiKeyResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorYubiKeyResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/two-factor/get-duo": { | |
"post": { | |
"tags": [ | |
"TwoFactor" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/SecretVerificationRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/SecretVerificationRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/SecretVerificationRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorDuoResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorDuoResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorDuoResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/two-factor/duo": { | |
"put": { | |
"tags": [ | |
"TwoFactor" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/UpdateTwoFactorDuoRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/UpdateTwoFactorDuoRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/UpdateTwoFactorDuoRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorDuoResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorDuoResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorDuoResponseModel" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"post": { | |
"tags": [ | |
"TwoFactor" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/UpdateTwoFactorDuoRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/UpdateTwoFactorDuoRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/UpdateTwoFactorDuoRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorDuoResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorDuoResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorDuoResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/organizations/{id}/two-factor/get-duo": { | |
"post": { | |
"tags": [ | |
"TwoFactor" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/SecretVerificationRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/SecretVerificationRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/SecretVerificationRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorDuoResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorDuoResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorDuoResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/organizations/{id}/two-factor/duo": { | |
"put": { | |
"tags": [ | |
"TwoFactor" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/UpdateTwoFactorDuoRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/UpdateTwoFactorDuoRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/UpdateTwoFactorDuoRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorDuoResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorDuoResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorDuoResponseModel" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"post": { | |
"tags": [ | |
"TwoFactor" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/UpdateTwoFactorDuoRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/UpdateTwoFactorDuoRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/UpdateTwoFactorDuoRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorDuoResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorDuoResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorDuoResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/two-factor/get-webauthn": { | |
"post": { | |
"tags": [ | |
"TwoFactor" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/SecretVerificationRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/SecretVerificationRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/SecretVerificationRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorWebAuthnResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorWebAuthnResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorWebAuthnResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/two-factor/get-webauthn-challenge": { | |
"post": { | |
"tags": [ | |
"TwoFactor" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/SecretVerificationRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/SecretVerificationRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/SecretVerificationRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/CredentialCreateOptions" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CredentialCreateOptions" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/CredentialCreateOptions" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/two-factor/webauthn": { | |
"put": { | |
"tags": [ | |
"TwoFactor" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorWebAuthnRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorWebAuthnRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorWebAuthnRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorWebAuthnResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorWebAuthnResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorWebAuthnResponseModel" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"post": { | |
"tags": [ | |
"TwoFactor" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorWebAuthnRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorWebAuthnRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorWebAuthnRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorWebAuthnResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorWebAuthnResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorWebAuthnResponseModel" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"delete": { | |
"tags": [ | |
"TwoFactor" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorWebAuthnDeleteRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorWebAuthnDeleteRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorWebAuthnDeleteRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorWebAuthnResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorWebAuthnResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorWebAuthnResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/two-factor/get-email": { | |
"post": { | |
"tags": [ | |
"TwoFactor" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/SecretVerificationRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/SecretVerificationRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/SecretVerificationRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorEmailResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorEmailResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorEmailResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/two-factor/send-email": { | |
"post": { | |
"tags": [ | |
"TwoFactor" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorEmailRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorEmailRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorEmailRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/two-factor/send-email-login": { | |
"post": { | |
"tags": [ | |
"TwoFactor" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorEmailRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorEmailRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorEmailRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/two-factor/email": { | |
"put": { | |
"tags": [ | |
"TwoFactor" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/UpdateTwoFactorEmailRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/UpdateTwoFactorEmailRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/UpdateTwoFactorEmailRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorEmailResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorEmailResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorEmailResponseModel" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"post": { | |
"tags": [ | |
"TwoFactor" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/UpdateTwoFactorEmailRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/UpdateTwoFactorEmailRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/UpdateTwoFactorEmailRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorEmailResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorEmailResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorEmailResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/two-factor/disable": { | |
"put": { | |
"tags": [ | |
"TwoFactor" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorProviderRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorProviderRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorProviderRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorProviderResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorProviderResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorProviderResponseModel" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"post": { | |
"tags": [ | |
"TwoFactor" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorProviderRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorProviderRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorProviderRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorProviderResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorProviderResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorProviderResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/organizations/{id}/two-factor/disable": { | |
"put": { | |
"tags": [ | |
"TwoFactor" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorProviderRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorProviderRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorProviderRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorProviderResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorProviderResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorProviderResponseModel" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"post": { | |
"tags": [ | |
"TwoFactor" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorProviderRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorProviderRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorProviderRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorProviderResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorProviderResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorProviderResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/two-factor/get-recover": { | |
"post": { | |
"tags": [ | |
"TwoFactor" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/SecretVerificationRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/SecretVerificationRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/SecretVerificationRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorRecoverResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorRecoverResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorRecoverResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/two-factor/recover": { | |
"post": { | |
"tags": [ | |
"TwoFactor" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorRecoveryRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorRecoveryRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/TwoFactorRecoveryRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success" | |
} | |
} | |
} | |
}, | |
"/two-factor/get-device-verification-settings": { | |
"get": { | |
"tags": [ | |
"TwoFactor" | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/DeviceVerificationResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/DeviceVerificationResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/DeviceVerificationResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/two-factor/device-verification-settings": { | |
"put": { | |
"tags": [ | |
"TwoFactor" | |
], | |
"requestBody": { | |
"content": { | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/DeviceVerificationRequestModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/DeviceVerificationRequestModel" | |
} | |
}, | |
"application/*+json": { | |
"schema": { | |
"$ref": "#/components/schemas/DeviceVerificationRequestModel" | |
} | |
} | |
} | |
}, | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/DeviceVerificationResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/DeviceVerificationResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/DeviceVerificationResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"/users/{id}/public-key": { | |
"get": { | |
"tags": [ | |
"Users" | |
], | |
"parameters": [ | |
{ | |
"name": "id", | |
"in": "path", | |
"required": true, | |
"schema": { | |
"type": "string" | |
} | |
} | |
], | |
"responses": { | |
"200": { | |
"description": "Success", | |
"content": { | |
"text/plain": { | |
"schema": { | |
"$ref": "#/components/schemas/UserKeyResponseModel" | |
} | |
}, | |
"application/json": { | |
"schema": { | |
"$ref": "#/components/schemas/UserKeyResponseModel" | |
} | |
}, | |
"text/json": { | |
"schema": { | |
"$ref": "#/components/schemas/UserKeyResponseModel" | |
} | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"components": { | |
"schemas": { | |
"Algorithm": { | |
"enum": [ | |
-65535, | |
-259, | |
-258, | |
-257, | |
-47, | |
-39, | |
-38, | |
-37, | |
-36, | |
-35, | |
-8, | |
-7 | |
], | |
"type": "integer", | |
"format": "int32" | |
}, | |
"ApiKeyResponseModel": { | |
"type": "object", | |
"properties": { | |
"object": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"apiKey": { | |
"type": "string", | |
"nullable": true | |
}, | |
"revisionDate": { | |
"type": "string", | |
"format": "date-time" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"AttachmentRequestModel": { | |
"type": "object", | |
"properties": { | |
"key": { | |
"type": "string", | |
"nullable": true | |
}, | |
"fileName": { | |
"type": "string", | |
"nullable": true | |
}, | |
"fileSize": { | |
"type": "integer", | |
"format": "int64" | |
}, | |
"adminRequest": { | |
"type": "boolean" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"AttachmentResponseModel": { | |
"type": "object", | |
"properties": { | |
"object": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"id": { | |
"type": "string", | |
"nullable": true | |
}, | |
"url": { | |
"type": "string", | |
"nullable": true | |
}, | |
"fileName": { | |
"type": "string", | |
"nullable": true | |
}, | |
"key": { | |
"type": "string", | |
"nullable": true | |
}, | |
"size": { | |
"type": "integer", | |
"format": "int64" | |
}, | |
"sizeName": { | |
"type": "string", | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"AttachmentUploadDataResponseModel": { | |
"type": "object", | |
"properties": { | |
"object": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"attachmentId": { | |
"type": "string", | |
"nullable": true | |
}, | |
"url": { | |
"type": "string", | |
"nullable": true | |
}, | |
"fileUploadType": { | |
"$ref": "#/components/schemas/FileUploadType" | |
}, | |
"cipherResponse": { | |
"$ref": "#/components/schemas/CipherResponseModel" | |
}, | |
"cipherMiniResponse": { | |
"$ref": "#/components/schemas/CipherMiniResponseModel" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"AttestationConveyancePreference": { | |
"enum": [ | |
"none", | |
"indirect", | |
"direct" | |
], | |
"type": "string" | |
}, | |
"AuthenticationExtensionsClientInputs": { | |
"type": "object", | |
"properties": { | |
"example.extension": { | |
"nullable": true | |
}, | |
"appid": { | |
"type": "string", | |
"nullable": true | |
}, | |
"authnSel": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"format": "byte" | |
}, | |
"nullable": true | |
}, | |
"exts": { | |
"type": "boolean", | |
"nullable": true | |
}, | |
"uvm": { | |
"type": "boolean", | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"AuthenticationExtensionsClientOutputs": { | |
"type": "object", | |
"properties": { | |
"example.extension": { | |
"nullable": true | |
}, | |
"appid": { | |
"type": "boolean" | |
}, | |
"authnSel": { | |
"type": "boolean" | |
}, | |
"exts": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
}, | |
"nullable": true | |
}, | |
"uvm": { | |
"type": "array", | |
"items": { | |
"type": "array", | |
"items": { | |
"type": "integer", | |
"format": "int64" | |
} | |
}, | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"AuthenticatorAttachment": { | |
"enum": [ | |
"platform", | |
"cross-platform" | |
], | |
"type": "string" | |
}, | |
"AuthenticatorAttestationRawResponse": { | |
"type": "object", | |
"properties": { | |
"id": { | |
"type": "string", | |
"format": "byte", | |
"nullable": true | |
}, | |
"rawId": { | |
"type": "string", | |
"format": "byte", | |
"nullable": true | |
}, | |
"type": { | |
"$ref": "#/components/schemas/PublicKeyCredentialType" | |
}, | |
"response": { | |
"$ref": "#/components/schemas/ResponseData" | |
}, | |
"extensions": { | |
"$ref": "#/components/schemas/AuthenticationExtensionsClientOutputs" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"AuthenticatorSelection": { | |
"type": "object", | |
"properties": { | |
"authenticatorAttachment": { | |
"$ref": "#/components/schemas/AuthenticatorAttachment" | |
}, | |
"requireResidentKey": { | |
"type": "boolean" | |
}, | |
"userVerification": { | |
"$ref": "#/components/schemas/UserVerificationRequirement" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"AuthenticatorTransport": { | |
"enum": [ | |
"usb", | |
"nfc", | |
"ble", | |
"internal" | |
], | |
"type": "string" | |
}, | |
"BillingHistoryResponseModel": { | |
"type": "object", | |
"properties": { | |
"object": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"invoices": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/BillingInvoice" | |
}, | |
"nullable": true | |
}, | |
"transactions": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/BillingTransaction" | |
}, | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"BillingInvoice": { | |
"type": "object", | |
"properties": { | |
"amount": { | |
"type": "number", | |
"format": "double" | |
}, | |
"date": { | |
"type": "string", | |
"format": "date-time", | |
"nullable": true | |
}, | |
"url": { | |
"type": "string", | |
"nullable": true | |
}, | |
"pdfUrl": { | |
"type": "string", | |
"nullable": true | |
}, | |
"number": { | |
"type": "string", | |
"nullable": true | |
}, | |
"paid": { | |
"type": "boolean" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"BillingPaymentResponseModel": { | |
"type": "object", | |
"properties": { | |
"object": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"balance": { | |
"type": "number", | |
"format": "double" | |
}, | |
"paymentSource": { | |
"$ref": "#/components/schemas/BillingSource" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"BillingResponseModel": { | |
"type": "object", | |
"properties": { | |
"object": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"balance": { | |
"type": "number", | |
"format": "double" | |
}, | |
"paymentSource": { | |
"$ref": "#/components/schemas/BillingSource" | |
}, | |
"invoices": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/BillingInvoice" | |
}, | |
"nullable": true | |
}, | |
"transactions": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/BillingTransaction" | |
}, | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"BillingSource": { | |
"type": "object", | |
"properties": { | |
"type": { | |
"$ref": "#/components/schemas/PaymentMethodType" | |
}, | |
"cardBrand": { | |
"type": "string", | |
"nullable": true | |
}, | |
"description": { | |
"type": "string", | |
"nullable": true | |
}, | |
"needsVerification": { | |
"type": "boolean" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"BillingSubscription": { | |
"type": "object", | |
"properties": { | |
"trialStartDate": { | |
"type": "string", | |
"format": "date-time", | |
"nullable": true | |
}, | |
"trialEndDate": { | |
"type": "string", | |
"format": "date-time", | |
"nullable": true | |
}, | |
"periodStartDate": { | |
"type": "string", | |
"format": "date-time", | |
"nullable": true | |
}, | |
"periodEndDate": { | |
"type": "string", | |
"format": "date-time", | |
"nullable": true | |
}, | |
"cancelledDate": { | |
"type": "string", | |
"format": "date-time", | |
"nullable": true | |
}, | |
"cancelAtEndDate": { | |
"type": "boolean" | |
}, | |
"status": { | |
"type": "string", | |
"nullable": true | |
}, | |
"cancelled": { | |
"type": "boolean" | |
}, | |
"items": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/BillingSubscriptionItem" | |
}, | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"BillingSubscriptionItem": { | |
"type": "object", | |
"properties": { | |
"name": { | |
"type": "string", | |
"nullable": true | |
}, | |
"amount": { | |
"type": "number", | |
"format": "double" | |
}, | |
"quantity": { | |
"type": "integer", | |
"format": "int32" | |
}, | |
"interval": { | |
"type": "string", | |
"nullable": true | |
}, | |
"sponsoredSubscriptionItem": { | |
"type": "boolean" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"BillingSubscriptionUpcomingInvoice": { | |
"type": "object", | |
"properties": { | |
"amount": { | |
"type": "number", | |
"format": "double" | |
}, | |
"date": { | |
"type": "string", | |
"format": "date-time", | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"BillingTransaction": { | |
"type": "object", | |
"properties": { | |
"createdDate": { | |
"type": "string", | |
"format": "date-time" | |
}, | |
"amount": { | |
"type": "number", | |
"format": "double" | |
}, | |
"refunded": { | |
"type": "boolean", | |
"nullable": true | |
}, | |
"partiallyRefunded": { | |
"type": "boolean", | |
"nullable": true | |
}, | |
"refundedAmount": { | |
"type": "number", | |
"format": "double", | |
"nullable": true | |
}, | |
"type": { | |
"$ref": "#/components/schemas/TransactionType" | |
}, | |
"paymentMethodType": { | |
"$ref": "#/components/schemas/PaymentMethodType" | |
}, | |
"details": { | |
"type": "string", | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"BitPayInvoiceRequestModel": { | |
"required": [ | |
"amount" | |
], | |
"type": "object", | |
"properties": { | |
"userId": { | |
"type": "string", | |
"format": "uuid", | |
"nullable": true | |
}, | |
"organizationId": { | |
"type": "string", | |
"format": "uuid", | |
"nullable": true | |
}, | |
"credit": { | |
"type": "boolean" | |
}, | |
"amount": { | |
"type": "number", | |
"format": "double" | |
}, | |
"returnUrl": { | |
"type": "string", | |
"nullable": true | |
}, | |
"name": { | |
"type": "string", | |
"nullable": true | |
}, | |
"email": { | |
"type": "string", | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"CipherAttachmentModel": { | |
"type": "object", | |
"properties": { | |
"fileName": { | |
"maxLength": 1000, | |
"minLength": 0, | |
"type": "string", | |
"nullable": true | |
}, | |
"key": { | |
"maxLength": 1000, | |
"minLength": 0, | |
"type": "string", | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"CipherBulkDeleteRequestModel": { | |
"required": [ | |
"ids" | |
], | |
"type": "object", | |
"properties": { | |
"ids": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"organizationId": { | |
"type": "string", | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"CipherBulkMoveRequestModel": { | |
"required": [ | |
"ids" | |
], | |
"type": "object", | |
"properties": { | |
"ids": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"folderId": { | |
"type": "string", | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"CipherBulkRestoreRequestModel": { | |
"required": [ | |
"ids" | |
], | |
"type": "object", | |
"properties": { | |
"ids": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"CipherBulkShareRequestModel": { | |
"required": [ | |
"ciphers", | |
"collectionIds" | |
], | |
"type": "object", | |
"properties": { | |
"collectionIds": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"ciphers": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/CipherWithIdRequestModel" | |
} | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"CipherCardModel": { | |
"type": "object", | |
"properties": { | |
"cardholderName": { | |
"maxLength": 1000, | |
"minLength": 0, | |
"type": "string", | |
"nullable": true | |
}, | |
"brand": { | |
"maxLength": 1000, | |
"minLength": 0, | |
"type": "string", | |
"nullable": true | |
}, | |
"number": { | |
"maxLength": 1000, | |
"minLength": 0, | |
"type": "string", | |
"nullable": true | |
}, | |
"expMonth": { | |
"maxLength": 1000, | |
"minLength": 0, | |
"type": "string", | |
"nullable": true | |
}, | |
"expYear": { | |
"maxLength": 1000, | |
"minLength": 0, | |
"type": "string", | |
"nullable": true | |
}, | |
"code": { | |
"maxLength": 1000, | |
"minLength": 0, | |
"type": "string", | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"CipherCollectionsRequestModel": { | |
"required": [ | |
"collectionIds" | |
], | |
"type": "object", | |
"properties": { | |
"collectionIds": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"CipherCreateRequestModel": { | |
"required": [ | |
"cipher" | |
], | |
"type": "object", | |
"properties": { | |
"collectionIds": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"format": "uuid" | |
}, | |
"nullable": true | |
}, | |
"cipher": { | |
"$ref": "#/components/schemas/CipherRequestModel" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"CipherDetailsResponseModel": { | |
"type": "object", | |
"properties": { | |
"object": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"id": { | |
"type": "string", | |
"nullable": true | |
}, | |
"organizationId": { | |
"type": "string", | |
"nullable": true | |
}, | |
"type": { | |
"$ref": "#/components/schemas/CipherType" | |
}, | |
"data": { | |
"nullable": true | |
}, | |
"name": { | |
"type": "string", | |
"nullable": true | |
}, | |
"notes": { | |
"type": "string", | |
"nullable": true | |
}, | |
"login": { | |
"$ref": "#/components/schemas/CipherLoginModel" | |
}, | |
"card": { | |
"$ref": "#/components/schemas/CipherCardModel" | |
}, | |
"identity": { | |
"$ref": "#/components/schemas/CipherIdentityModel" | |
}, | |
"secureNote": { | |
"$ref": "#/components/schemas/CipherSecureNoteModel" | |
}, | |
"fields": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/CipherFieldModel" | |
}, | |
"nullable": true | |
}, | |
"passwordHistory": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/CipherPasswordHistoryModel" | |
}, | |
"nullable": true | |
}, | |
"attachments": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/AttachmentResponseModel" | |
}, | |
"nullable": true | |
}, | |
"organizationUseTotp": { | |
"type": "boolean" | |
}, | |
"revisionDate": { | |
"type": "string", | |
"format": "date-time" | |
}, | |
"deletedDate": { | |
"type": "string", | |
"format": "date-time", | |
"nullable": true | |
}, | |
"reprompt": { | |
"$ref": "#/components/schemas/CipherRepromptType" | |
}, | |
"folderId": { | |
"type": "string", | |
"nullable": true | |
}, | |
"favorite": { | |
"type": "boolean" | |
}, | |
"edit": { | |
"type": "boolean" | |
}, | |
"viewPassword": { | |
"type": "boolean" | |
}, | |
"collectionIds": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"format": "uuid" | |
}, | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"CipherDetailsResponseModelListResponseModel": { | |
"type": "object", | |
"properties": { | |
"object": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"data": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/CipherDetailsResponseModel" | |
}, | |
"nullable": true | |
}, | |
"continuationToken": { | |
"type": "string", | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"CipherFieldModel": { | |
"type": "object", | |
"properties": { | |
"type": { | |
"$ref": "#/components/schemas/FieldType" | |
}, | |
"name": { | |
"maxLength": 1000, | |
"minLength": 0, | |
"type": "string", | |
"nullable": true | |
}, | |
"value": { | |
"maxLength": 5000, | |
"minLength": 0, | |
"type": "string", | |
"nullable": true | |
}, | |
"linkedId": { | |
"type": "integer", | |
"format": "int32", | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"CipherIdentityModel": { | |
"type": "object", | |
"properties": { | |
"title": { | |
"maxLength": 1000, | |
"minLength": 0, | |
"type": "string", | |
"nullable": true | |
}, | |
"firstName": { | |
"maxLength": 1000, | |
"minLength": 0, | |
"type": "string", | |
"nullable": true | |
}, | |
"middleName": { | |
"maxLength": 1000, | |
"minLength": 0, | |
"type": "string", | |
"nullable": true | |
}, | |
"lastName": { | |
"maxLength": 1000, | |
"minLength": 0, | |
"type": "string", | |
"nullable": true | |
}, | |
"address1": { | |
"maxLength": 1000, | |
"minLength": 0, | |
"type": "string", | |
"nullable": true | |
}, | |
"address2": { | |
"maxLength": 1000, | |
"minLength": 0, | |
"type": "string", | |
"nullable": true | |
}, | |
"address3": { | |
"maxLength": 1000, | |
"minLength": 0, | |
"type": "string", | |
"nullable": true | |
}, | |
"city": { | |
"maxLength": 1000, | |
"minLength": 0, | |
"type": "string", | |
"nullable": true | |
}, | |
"state": { | |
"maxLength": 1000, | |
"minLength": 0, | |
"type": "string", | |
"nullable": true | |
}, | |
"postalCode": { | |
"maxLength": 1000, | |
"minLength": 0, | |
"type": "string", | |
"nullable": true | |
}, | |
"country": { | |
"maxLength": 1000, | |
"minLength": 0, | |
"type": "string", | |
"nullable": true | |
}, | |
"company": { | |
"maxLength": 1000, | |
"minLength": 0, | |
"type": "string", | |
"nullable": true | |
}, | |
"email": { | |
"maxLength": 1000, | |
"minLength": 0, | |
"type": "string", | |
"nullable": true | |
}, | |
"phone": { | |
"maxLength": 1000, | |
"minLength": 0, | |
"type": "string", | |
"nullable": true | |
}, | |
"ssn": { | |
"maxLength": 1000, | |
"minLength": 0, | |
"type": "string", | |
"nullable": true | |
}, | |
"username": { | |
"maxLength": 1000, | |
"minLength": 0, | |
"type": "string", | |
"nullable": true | |
}, | |
"passportNumber": { | |
"maxLength": 1000, | |
"minLength": 0, | |
"type": "string", | |
"nullable": true | |
}, | |
"licenseNumber": { | |
"maxLength": 1000, | |
"minLength": 0, | |
"type": "string", | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"CipherLoginModel": { | |
"type": "object", | |
"properties": { | |
"uri": { | |
"maxLength": 10000, | |
"minLength": 0, | |
"type": "string", | |
"nullable": true | |
}, | |
"uris": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/CipherLoginUriModel" | |
}, | |
"nullable": true | |
}, | |
"username": { | |
"maxLength": 1000, | |
"minLength": 0, | |
"type": "string", | |
"nullable": true | |
}, | |
"password": { | |
"maxLength": 5000, | |
"minLength": 0, | |
"type": "string", | |
"nullable": true | |
}, | |
"passwordRevisionDate": { | |
"type": "string", | |
"format": "date-time", | |
"nullable": true | |
}, | |
"totp": { | |
"maxLength": 1000, | |
"minLength": 0, | |
"type": "string", | |
"nullable": true | |
}, | |
"autofillOnPageLoad": { | |
"type": "boolean", | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"CipherLoginUriModel": { | |
"type": "object", | |
"properties": { | |
"uri": { | |
"maxLength": 10000, | |
"minLength": 0, | |
"type": "string", | |
"nullable": true | |
}, | |
"match": { | |
"$ref": "#/components/schemas/UriMatchType" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"CipherMiniDetailsResponseModel": { | |
"type": "object", | |
"properties": { | |
"object": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"id": { | |
"type": "string", | |
"nullable": true | |
}, | |
"organizationId": { | |
"type": "string", | |
"nullable": true | |
}, | |
"type": { | |
"$ref": "#/components/schemas/CipherType" | |
}, | |
"data": { | |
"nullable": true | |
}, | |
"name": { | |
"type": "string", | |
"nullable": true | |
}, | |
"notes": { | |
"type": "string", | |
"nullable": true | |
}, | |
"login": { | |
"$ref": "#/components/schemas/CipherLoginModel" | |
}, | |
"card": { | |
"$ref": "#/components/schemas/CipherCardModel" | |
}, | |
"identity": { | |
"$ref": "#/components/schemas/CipherIdentityModel" | |
}, | |
"secureNote": { | |
"$ref": "#/components/schemas/CipherSecureNoteModel" | |
}, | |
"fields": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/CipherFieldModel" | |
}, | |
"nullable": true | |
}, | |
"passwordHistory": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/CipherPasswordHistoryModel" | |
}, | |
"nullable": true | |
}, | |
"attachments": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/AttachmentResponseModel" | |
}, | |
"nullable": true | |
}, | |
"organizationUseTotp": { | |
"type": "boolean" | |
}, | |
"revisionDate": { | |
"type": "string", | |
"format": "date-time" | |
}, | |
"deletedDate": { | |
"type": "string", | |
"format": "date-time", | |
"nullable": true | |
}, | |
"reprompt": { | |
"$ref": "#/components/schemas/CipherRepromptType" | |
}, | |
"collectionIds": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"format": "uuid" | |
}, | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"CipherMiniDetailsResponseModelListResponseModel": { | |
"type": "object", | |
"properties": { | |
"object": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"data": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/CipherMiniDetailsResponseModel" | |
}, | |
"nullable": true | |
}, | |
"continuationToken": { | |
"type": "string", | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"CipherMiniResponseModel": { | |
"type": "object", | |
"properties": { | |
"object": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"id": { | |
"type": "string", | |
"nullable": true | |
}, | |
"organizationId": { | |
"type": "string", | |
"nullable": true | |
}, | |
"type": { | |
"$ref": "#/components/schemas/CipherType" | |
}, | |
"data": { | |
"nullable": true | |
}, | |
"name": { | |
"type": "string", | |
"nullable": true | |
}, | |
"notes": { | |
"type": "string", | |
"nullable": true | |
}, | |
"login": { | |
"$ref": "#/components/schemas/CipherLoginModel" | |
}, | |
"card": { | |
"$ref": "#/components/schemas/CipherCardModel" | |
}, | |
"identity": { | |
"$ref": "#/components/schemas/CipherIdentityModel" | |
}, | |
"secureNote": { | |
"$ref": "#/components/schemas/CipherSecureNoteModel" | |
}, | |
"fields": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/CipherFieldModel" | |
}, | |
"nullable": true | |
}, | |
"passwordHistory": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/CipherPasswordHistoryModel" | |
}, | |
"nullable": true | |
}, | |
"attachments": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/AttachmentResponseModel" | |
}, | |
"nullable": true | |
}, | |
"organizationUseTotp": { | |
"type": "boolean" | |
}, | |
"revisionDate": { | |
"type": "string", | |
"format": "date-time" | |
}, | |
"deletedDate": { | |
"type": "string", | |
"format": "date-time", | |
"nullable": true | |
}, | |
"reprompt": { | |
"$ref": "#/components/schemas/CipherRepromptType" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"CipherPartialRequestModel": { | |
"type": "object", | |
"properties": { | |
"folderId": { | |
"maxLength": 36, | |
"minLength": 0, | |
"type": "string", | |
"nullable": true | |
}, | |
"favorite": { | |
"type": "boolean" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"CipherPasswordHistoryModel": { | |
"required": [ | |
"lastUsedDate", | |
"password" | |
], | |
"type": "object", | |
"properties": { | |
"password": { | |
"maxLength": 5000, | |
"minLength": 0, | |
"type": "string" | |
}, | |
"lastUsedDate": { | |
"type": "string", | |
"format": "date-time" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"CipherRepromptType": { | |
"enum": [ | |
0, | |
1 | |
], | |
"type": "integer", | |
"format": "int32" | |
}, | |
"CipherRequestModel": { | |
"required": [ | |
"name" | |
], | |
"type": "object", | |
"properties": { | |
"type": { | |
"$ref": "#/components/schemas/CipherType" | |
}, | |
"organizationId": { | |
"maxLength": 36, | |
"minLength": 0, | |
"type": "string", | |
"nullable": true | |
}, | |
"folderId": { | |
"type": "string", | |
"nullable": true | |
}, | |
"favorite": { | |
"type": "boolean" | |
}, | |
"reprompt": { | |
"$ref": "#/components/schemas/CipherRepromptType" | |
}, | |
"name": { | |
"maxLength": 1000, | |
"minLength": 0, | |
"type": "string" | |
}, | |
"notes": { | |
"maxLength": 10000, | |
"minLength": 0, | |
"type": "string", | |
"nullable": true | |
}, | |
"fields": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/CipherFieldModel" | |
}, | |
"nullable": true | |
}, | |
"passwordHistory": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/CipherPasswordHistoryModel" | |
}, | |
"nullable": true | |
}, | |
"attachments": { | |
"type": "object", | |
"additionalProperties": { | |
"type": "string", | |
"nullable": true | |
}, | |
"nullable": true, | |
"deprecated": true | |
}, | |
"attachments2": { | |
"type": "object", | |
"additionalProperties": { | |
"$ref": "#/components/schemas/CipherAttachmentModel" | |
}, | |
"nullable": true | |
}, | |
"login": { | |
"$ref": "#/components/schemas/CipherLoginModel" | |
}, | |
"card": { | |
"$ref": "#/components/schemas/CipherCardModel" | |
}, | |
"identity": { | |
"$ref": "#/components/schemas/CipherIdentityModel" | |
}, | |
"secureNote": { | |
"$ref": "#/components/schemas/CipherSecureNoteModel" | |
}, | |
"lastKnownRevisionDate": { | |
"type": "string", | |
"format": "date-time", | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"CipherResponseModel": { | |
"type": "object", | |
"properties": { | |
"object": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"id": { | |
"type": "string", | |
"nullable": true | |
}, | |
"organizationId": { | |
"type": "string", | |
"nullable": true | |
}, | |
"type": { | |
"$ref": "#/components/schemas/CipherType" | |
}, | |
"data": { | |
"nullable": true | |
}, | |
"name": { | |
"type": "string", | |
"nullable": true | |
}, | |
"notes": { | |
"type": "string", | |
"nullable": true | |
}, | |
"login": { | |
"$ref": "#/components/schemas/CipherLoginModel" | |
}, | |
"card": { | |
"$ref": "#/components/schemas/CipherCardModel" | |
}, | |
"identity": { | |
"$ref": "#/components/schemas/CipherIdentityModel" | |
}, | |
"secureNote": { | |
"$ref": "#/components/schemas/CipherSecureNoteModel" | |
}, | |
"fields": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/CipherFieldModel" | |
}, | |
"nullable": true | |
}, | |
"passwordHistory": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/CipherPasswordHistoryModel" | |
}, | |
"nullable": true | |
}, | |
"attachments": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/AttachmentResponseModel" | |
}, | |
"nullable": true | |
}, | |
"organizationUseTotp": { | |
"type": "boolean" | |
}, | |
"revisionDate": { | |
"type": "string", | |
"format": "date-time" | |
}, | |
"deletedDate": { | |
"type": "string", | |
"format": "date-time", | |
"nullable": true | |
}, | |
"reprompt": { | |
"$ref": "#/components/schemas/CipherRepromptType" | |
}, | |
"folderId": { | |
"type": "string", | |
"nullable": true | |
}, | |
"favorite": { | |
"type": "boolean" | |
}, | |
"edit": { | |
"type": "boolean" | |
}, | |
"viewPassword": { | |
"type": "boolean" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"CipherResponseModelListResponseModel": { | |
"type": "object", | |
"properties": { | |
"object": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"data": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/CipherResponseModel" | |
}, | |
"nullable": true | |
}, | |
"continuationToken": { | |
"type": "string", | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"CipherSecureNoteModel": { | |
"type": "object", | |
"properties": { | |
"type": { | |
"$ref": "#/components/schemas/SecureNoteType" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"CipherShareRequestModel": { | |
"required": [ | |
"cipher", | |
"collectionIds" | |
], | |
"type": "object", | |
"properties": { | |
"collectionIds": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"cipher": { | |
"$ref": "#/components/schemas/CipherRequestModel" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"CipherType": { | |
"enum": [ | |
1, | |
2, | |
3, | |
4 | |
], | |
"type": "integer", | |
"format": "int32" | |
}, | |
"CipherWithIdRequestModel": { | |
"required": [ | |
"id", | |
"name" | |
], | |
"type": "object", | |
"properties": { | |
"type": { | |
"$ref": "#/components/schemas/CipherType" | |
}, | |
"organizationId": { | |
"maxLength": 36, | |
"minLength": 0, | |
"type": "string", | |
"nullable": true | |
}, | |
"folderId": { | |
"type": "string", | |
"nullable": true | |
}, | |
"favorite": { | |
"type": "boolean" | |
}, | |
"reprompt": { | |
"$ref": "#/components/schemas/CipherRepromptType" | |
}, | |
"name": { | |
"maxLength": 1000, | |
"minLength": 0, | |
"type": "string" | |
}, | |
"notes": { | |
"maxLength": 10000, | |
"minLength": 0, | |
"type": "string", | |
"nullable": true | |
}, | |
"fields": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/CipherFieldModel" | |
}, | |
"nullable": true | |
}, | |
"passwordHistory": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/CipherPasswordHistoryModel" | |
}, | |
"nullable": true | |
}, | |
"attachments": { | |
"type": "object", | |
"additionalProperties": { | |
"type": "string", | |
"nullable": true | |
}, | |
"nullable": true, | |
"deprecated": true | |
}, | |
"attachments2": { | |
"type": "object", | |
"additionalProperties": { | |
"$ref": "#/components/schemas/CipherAttachmentModel" | |
}, | |
"nullable": true | |
}, | |
"login": { | |
"$ref": "#/components/schemas/CipherLoginModel" | |
}, | |
"card": { | |
"$ref": "#/components/schemas/CipherCardModel" | |
}, | |
"identity": { | |
"$ref": "#/components/schemas/CipherIdentityModel" | |
}, | |
"secureNote": { | |
"$ref": "#/components/schemas/CipherSecureNoteModel" | |
}, | |
"lastKnownRevisionDate": { | |
"type": "string", | |
"format": "date-time", | |
"nullable": true | |
}, | |
"id": { | |
"type": "string", | |
"format": "uuid" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"CollectionDetailsResponseModel": { | |
"type": "object", | |
"properties": { | |
"object": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"id": { | |
"type": "string", | |
"nullable": true | |
}, | |
"organizationId": { | |
"type": "string", | |
"nullable": true | |
}, | |
"name": { | |
"type": "string", | |
"nullable": true | |
}, | |
"externalId": { | |
"type": "string", | |
"nullable": true | |
}, | |
"readOnly": { | |
"type": "boolean" | |
}, | |
"hidePasswords": { | |
"type": "boolean" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"CollectionDetailsResponseModelListResponseModel": { | |
"type": "object", | |
"properties": { | |
"object": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"data": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/CollectionDetailsResponseModel" | |
}, | |
"nullable": true | |
}, | |
"continuationToken": { | |
"type": "string", | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"CollectionGroupDetailsResponseModel": { | |
"type": "object", | |
"properties": { | |
"object": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"id": { | |
"type": "string", | |
"nullable": true | |
}, | |
"organizationId": { | |
"type": "string", | |
"nullable": true | |
}, | |
"name": { | |
"type": "string", | |
"nullable": true | |
}, | |
"externalId": { | |
"type": "string", | |
"nullable": true | |
}, | |
"groups": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/SelectionReadOnlyResponseModel" | |
}, | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"CollectionRequestModel": { | |
"required": [ | |
"name" | |
], | |
"type": "object", | |
"properties": { | |
"name": { | |
"maxLength": 1000, | |
"minLength": 0, | |
"type": "string" | |
}, | |
"externalId": { | |
"maxLength": 300, | |
"minLength": 0, | |
"type": "string", | |
"nullable": true | |
}, | |
"groups": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/SelectionReadOnlyRequestModel" | |
}, | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"CollectionResponseModel": { | |
"type": "object", | |
"properties": { | |
"object": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"id": { | |
"type": "string", | |
"nullable": true | |
}, | |
"organizationId": { | |
"type": "string", | |
"nullable": true | |
}, | |
"name": { | |
"type": "string", | |
"nullable": true | |
}, | |
"externalId": { | |
"type": "string", | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"CollectionResponseModelListResponseModel": { | |
"type": "object", | |
"properties": { | |
"object": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"data": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/CollectionResponseModel" | |
}, | |
"nullable": true | |
}, | |
"continuationToken": { | |
"type": "string", | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"CredentialCreateOptions": { | |
"type": "object", | |
"properties": { | |
"status": { | |
"type": "string", | |
"nullable": true | |
}, | |
"errorMessage": { | |
"type": "string", | |
"nullable": true | |
}, | |
"rp": { | |
"$ref": "#/components/schemas/PublicKeyCredentialRpEntity" | |
}, | |
"user": { | |
"$ref": "#/components/schemas/Fido2User" | |
}, | |
"challenge": { | |
"type": "string", | |
"format": "byte", | |
"nullable": true | |
}, | |
"pubKeyCredParams": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/PubKeyCredParam" | |
}, | |
"nullable": true | |
}, | |
"timeout": { | |
"type": "integer", | |
"format": "int64" | |
}, | |
"attestation": { | |
"$ref": "#/components/schemas/AttestationConveyancePreference" | |
}, | |
"authenticatorSelection": { | |
"$ref": "#/components/schemas/AuthenticatorSelection" | |
}, | |
"excludeCredentials": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/PublicKeyCredentialDescriptor" | |
}, | |
"nullable": true | |
}, | |
"extensions": { | |
"$ref": "#/components/schemas/AuthenticationExtensionsClientInputs" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"DeleteRecoverRequestModel": { | |
"required": [ | |
"email" | |
], | |
"type": "object", | |
"properties": { | |
"email": { | |
"maxLength": 256, | |
"minLength": 0, | |
"type": "string", | |
"format": "email" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"DeviceRequestModel": { | |
"required": [ | |
"identifier", | |
"name", | |
"type" | |
], | |
"type": "object", | |
"properties": { | |
"type": { | |
"$ref": "#/components/schemas/DeviceType" | |
}, | |
"name": { | |
"maxLength": 50, | |
"minLength": 0, | |
"type": "string" | |
}, | |
"identifier": { | |
"maxLength": 50, | |
"minLength": 0, | |
"type": "string" | |
}, | |
"pushToken": { | |
"maxLength": 255, | |
"minLength": 0, | |
"type": "string", | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"DeviceResponseModel": { | |
"type": "object", | |
"properties": { | |
"object": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"id": { | |
"type": "string", | |
"nullable": true | |
}, | |
"name": { | |
"type": "string", | |
"nullable": true | |
}, | |
"type": { | |
"$ref": "#/components/schemas/DeviceType" | |
}, | |
"identifier": { | |
"type": "string", | |
"nullable": true | |
}, | |
"creationDate": { | |
"type": "string", | |
"format": "date-time" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"DeviceResponseModelListResponseModel": { | |
"type": "object", | |
"properties": { | |
"object": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"data": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/DeviceResponseModel" | |
}, | |
"nullable": true | |
}, | |
"continuationToken": { | |
"type": "string", | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"DeviceTokenRequestModel": { | |
"type": "object", | |
"properties": { | |
"pushToken": { | |
"maxLength": 255, | |
"minLength": 0, | |
"type": "string", | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"DeviceType": { | |
"enum": [ | |
0, | |
1, | |
2, | |
3, | |
4, | |
5, | |
6, | |
7, | |
8, | |
9, | |
10, | |
11, | |
12, | |
13, | |
14, | |
15, | |
16, | |
17, | |
18, | |
19, | |
20 | |
], | |
"type": "integer", | |
"format": "int32" | |
}, | |
"DeviceVerificationRequestModel": { | |
"required": [ | |
"unknownDeviceVerificationEnabled" | |
], | |
"type": "object", | |
"properties": { | |
"unknownDeviceVerificationEnabled": { | |
"type": "boolean" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"DeviceVerificationResponseModel": { | |
"type": "object", | |
"properties": { | |
"object": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"isDeviceVerificationSectionEnabled": { | |
"type": "boolean" | |
}, | |
"unknownDeviceVerificationEnabled": { | |
"type": "boolean" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"DomainsResponseModel": { | |
"type": "object", | |
"properties": { | |
"object": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"equivalentDomains": { | |
"type": "array", | |
"items": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"nullable": true | |
}, | |
"globalEquivalentDomains": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/GlobalDomains" | |
}, | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"EmailRequestModel": { | |
"required": [ | |
"key", | |
"newEmail", | |
"newMasterPasswordHash", | |
"token" | |
], | |
"type": "object", | |
"properties": { | |
"masterPasswordHash": { | |
"maxLength": 300, | |
"minLength": 0, | |
"type": "string", | |
"nullable": true | |
}, | |
"otp": { | |
"type": "string", | |
"nullable": true | |
}, | |
"secret": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"newEmail": { | |
"maxLength": 256, | |
"minLength": 0, | |
"type": "string" | |
}, | |
"newMasterPasswordHash": { | |
"maxLength": 300, | |
"minLength": 0, | |
"type": "string" | |
}, | |
"token": { | |
"type": "string" | |
}, | |
"key": { | |
"type": "string" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"EmailTokenRequestModel": { | |
"required": [ | |
"newEmail" | |
], | |
"type": "object", | |
"properties": { | |
"masterPasswordHash": { | |
"maxLength": 300, | |
"minLength": 0, | |
"type": "string", | |
"nullable": true | |
}, | |
"otp": { | |
"type": "string", | |
"nullable": true | |
}, | |
"secret": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"newEmail": { | |
"maxLength": 256, | |
"minLength": 0, | |
"type": "string" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"EmergencyAccessGranteeDetailsResponseModel": { | |
"type": "object", | |
"properties": { | |
"object": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"id": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"status": { | |
"$ref": "#/components/schemas/EmergencyAccessStatusType" | |
}, | |
"type": { | |
"$ref": "#/components/schemas/EmergencyAccessType" | |
}, | |
"waitTimeDays": { | |
"type": "integer", | |
"format": "int32", | |
"readOnly": true | |
}, | |
"granteeId": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"name": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"email": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"EmergencyAccessGranteeDetailsResponseModelListResponseModel": { | |
"type": "object", | |
"properties": { | |
"object": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"data": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/EmergencyAccessGranteeDetailsResponseModel" | |
}, | |
"nullable": true | |
}, | |
"continuationToken": { | |
"type": "string", | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"EmergencyAccessGrantorDetailsResponseModel": { | |
"type": "object", | |
"properties": { | |
"object": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"id": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"status": { | |
"$ref": "#/components/schemas/EmergencyAccessStatusType" | |
}, | |
"type": { | |
"$ref": "#/components/schemas/EmergencyAccessType" | |
}, | |
"waitTimeDays": { | |
"type": "integer", | |
"format": "int32", | |
"readOnly": true | |
}, | |
"grantorId": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"name": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"email": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"EmergencyAccessGrantorDetailsResponseModelListResponseModel": { | |
"type": "object", | |
"properties": { | |
"object": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"data": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/EmergencyAccessGrantorDetailsResponseModel" | |
}, | |
"nullable": true | |
}, | |
"continuationToken": { | |
"type": "string", | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"EmergencyAccessInviteRequestModel": { | |
"required": [ | |
"email", | |
"type", | |
"waitTimeDays" | |
], | |
"type": "object", | |
"properties": { | |
"email": { | |
"maxLength": 256, | |
"minLength": 0, | |
"type": "string" | |
}, | |
"type": { | |
"$ref": "#/components/schemas/EmergencyAccessType" | |
}, | |
"waitTimeDays": { | |
"type": "integer", | |
"format": "int32" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"EmergencyAccessPasswordRequestModel": { | |
"required": [ | |
"key", | |
"newMasterPasswordHash" | |
], | |
"type": "object", | |
"properties": { | |
"newMasterPasswordHash": { | |
"maxLength": 300, | |
"minLength": 0, | |
"type": "string" | |
}, | |
"key": { | |
"type": "string" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"EmergencyAccessStatusType": { | |
"enum": [ | |
0, | |
1, | |
2, | |
3, | |
4 | |
], | |
"type": "integer", | |
"format": "int32" | |
}, | |
"EmergencyAccessTakeoverResponseModel": { | |
"type": "object", | |
"properties": { | |
"object": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"kdfIterations": { | |
"type": "integer", | |
"format": "int32", | |
"readOnly": true | |
}, | |
"kdf": { | |
"$ref": "#/components/schemas/KdfType" | |
}, | |
"keyEncrypted": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"EmergencyAccessType": { | |
"enum": [ | |
0, | |
1 | |
], | |
"type": "integer", | |
"format": "int32" | |
}, | |
"EmergencyAccessUpdateRequestModel": { | |
"required": [ | |
"type", | |
"waitTimeDays" | |
], | |
"type": "object", | |
"properties": { | |
"type": { | |
"$ref": "#/components/schemas/EmergencyAccessType" | |
}, | |
"waitTimeDays": { | |
"type": "integer", | |
"format": "int32" | |
}, | |
"keyEncrypted": { | |
"type": "string", | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"EmergencyAccessViewResponseModel": { | |
"type": "object", | |
"properties": { | |
"object": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"keyEncrypted": { | |
"type": "string", | |
"nullable": true | |
}, | |
"ciphers": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/CipherResponseModel" | |
}, | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"EventResponseModel": { | |
"type": "object", | |
"properties": { | |
"object": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"type": { | |
"$ref": "#/components/schemas/EventType" | |
}, | |
"userId": { | |
"type": "string", | |
"format": "uuid", | |
"nullable": true | |
}, | |
"organizationId": { | |
"type": "string", | |
"format": "uuid", | |
"nullable": true | |
}, | |
"providerId": { | |
"type": "string", | |
"format": "uuid", | |
"nullable": true | |
}, | |
"cipherId": { | |
"type": "string", | |
"format": "uuid", | |
"nullable": true | |
}, | |
"collectionId": { | |
"type": "string", | |
"format": "uuid", | |
"nullable": true | |
}, | |
"groupId": { | |
"type": "string", | |
"format": "uuid", | |
"nullable": true | |
}, | |
"policyId": { | |
"type": "string", | |
"format": "uuid", | |
"nullable": true | |
}, | |
"organizationUserId": { | |
"type": "string", | |
"format": "uuid", | |
"nullable": true | |
}, | |
"providerUserId": { | |
"type": "string", | |
"format": "uuid", | |
"nullable": true | |
}, | |
"providerOrganizationId": { | |
"type": "string", | |
"format": "uuid", | |
"nullable": true | |
}, | |
"actingUserId": { | |
"type": "string", | |
"format": "uuid", | |
"nullable": true | |
}, | |
"installationId": { | |
"type": "string", | |
"format": "uuid", | |
"nullable": true | |
}, | |
"date": { | |
"type": "string", | |
"format": "date-time" | |
}, | |
"deviceType": { | |
"$ref": "#/components/schemas/DeviceType" | |
}, | |
"ipAddress": { | |
"type": "string", | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"EventResponseModelListResponseModel": { | |
"type": "object", | |
"properties": { | |
"object": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"data": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/EventResponseModel" | |
}, | |
"nullable": true | |
}, | |
"continuationToken": { | |
"type": "string", | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"EventType": { | |
"enum": [ | |
1000, | |
1001, | |
1002, | |
1003, | |
1004, | |
1005, | |
1006, | |
1007, | |
1008, | |
1009, | |
1100, | |
1101, | |
1102, | |
1103, | |
1104, | |
1105, | |
1106, | |
1107, | |
1108, | |
1109, | |
1110, | |
1111, | |
1112, | |
1113, | |
1114, | |
1115, | |
1116, | |
1117, | |
1300, | |
1301, | |
1302, | |
1400, | |
1401, | |
1402, | |
1500, | |
1501, | |
1502, | |
1503, | |
1504, | |
1505, | |
1506, | |
1507, | |
1508, | |
1509, | |
1510, | |
1511, | |
1512, | |
1600, | |
1601, | |
1603, | |
1604, | |
1605, | |
1606, | |
1607, | |
1608, | |
1700, | |
1800, | |
1801, | |
1802, | |
1803, | |
1900, | |
1901, | |
1902, | |
1903 | |
], | |
"type": "integer", | |
"format": "int32" | |
}, | |
"Fido2User": { | |
"type": "object", | |
"properties": { | |
"name": { | |
"type": "string", | |
"nullable": true | |
}, | |
"id": { | |
"type": "string", | |
"format": "byte", | |
"nullable": true | |
}, | |
"displayName": { | |
"type": "string", | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"FieldType": { | |
"enum": [ | |
0, | |
1, | |
2, | |
3 | |
], | |
"type": "integer", | |
"format": "int32" | |
}, | |
"FileUploadType": { | |
"enum": [ | |
0, | |
1 | |
], | |
"type": "integer", | |
"format": "int32" | |
}, | |
"FolderRequestModel": { | |
"required": [ | |
"name" | |
], | |
"type": "object", | |
"properties": { | |
"name": { | |
"maxLength": 1000, | |
"minLength": 0, | |
"type": "string" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"FolderResponseModel": { | |
"type": "object", | |
"properties": { | |
"object": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"id": { | |
"type": "string", | |
"nullable": true | |
}, | |
"name": { | |
"type": "string", | |
"nullable": true | |
}, | |
"revisionDate": { | |
"type": "string", | |
"format": "date-time" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"FolderResponseModelListResponseModel": { | |
"type": "object", | |
"properties": { | |
"object": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"data": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/FolderResponseModel" | |
}, | |
"nullable": true | |
}, | |
"continuationToken": { | |
"type": "string", | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"FolderWithIdRequestModel": { | |
"required": [ | |
"name" | |
], | |
"type": "object", | |
"properties": { | |
"name": { | |
"maxLength": 1000, | |
"minLength": 0, | |
"type": "string" | |
}, | |
"id": { | |
"type": "string", | |
"format": "uuid" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"GlobalDomains": { | |
"type": "object", | |
"properties": { | |
"type": { | |
"$ref": "#/components/schemas/GlobalEquivalentDomainsType" | |
}, | |
"domains": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
}, | |
"nullable": true | |
}, | |
"excluded": { | |
"type": "boolean" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"GlobalEquivalentDomainsType": { | |
"enum": [ | |
0, | |
1, | |
2, | |
3, | |
4, | |
5, | |
6, | |
7, | |
8, | |
9, | |
10, | |
11, | |
12, | |
13, | |
14, | |
15, | |
16, | |
17, | |
18, | |
19, | |
20, | |
21, | |
22, | |
23, | |
24, | |
25, | |
26, | |
27, | |
28, | |
29, | |
30, | |
31, | |
32, | |
33, | |
34, | |
35, | |
36, | |
37, | |
38, | |
39, | |
40, | |
41, | |
42, | |
43, | |
44, | |
45, | |
46, | |
47, | |
48, | |
49, | |
50, | |
51, | |
52, | |
53, | |
54, | |
55, | |
56, | |
57, | |
58, | |
59, | |
60, | |
61, | |
62, | |
63, | |
64, | |
65, | |
66, | |
67, | |
68, | |
69, | |
70, | |
71, | |
72, | |
73, | |
74, | |
75, | |
76, | |
77, | |
78, | |
79, | |
80, | |
81, | |
82, | |
83, | |
84, | |
85, | |
86, | |
87, | |
88 | |
], | |
"type": "integer", | |
"format": "int32" | |
}, | |
"Group": { | |
"required": [ | |
"externalId", | |
"name" | |
], | |
"type": "object", | |
"properties": { | |
"name": { | |
"maxLength": 100, | |
"minLength": 0, | |
"type": "string" | |
}, | |
"externalId": { | |
"maxLength": 300, | |
"minLength": 0, | |
"type": "string" | |
}, | |
"users": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
}, | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"GroupDetailsResponseModel": { | |
"type": "object", | |
"properties": { | |
"object": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"id": { | |
"type": "string", | |
"nullable": true | |
}, | |
"organizationId": { | |
"type": "string", | |
"nullable": true | |
}, | |
"name": { | |
"type": "string", | |
"nullable": true | |
}, | |
"accessAll": { | |
"type": "boolean" | |
}, | |
"externalId": { | |
"type": "string", | |
"nullable": true | |
}, | |
"collections": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/SelectionReadOnlyResponseModel" | |
}, | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"GroupRequestModel": { | |
"required": [ | |
"accessAll", | |
"name" | |
], | |
"type": "object", | |
"properties": { | |
"name": { | |
"maxLength": 100, | |
"minLength": 0, | |
"type": "string" | |
}, | |
"accessAll": { | |
"type": "boolean" | |
}, | |
"externalId": { | |
"maxLength": 300, | |
"minLength": 0, | |
"type": "string", | |
"nullable": true | |
}, | |
"collections": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/SelectionReadOnlyRequestModel" | |
}, | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"GroupResponseModel": { | |
"type": "object", | |
"properties": { | |
"object": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"id": { | |
"type": "string", | |
"nullable": true | |
}, | |
"organizationId": { | |
"type": "string", | |
"nullable": true | |
}, | |
"name": { | |
"type": "string", | |
"nullable": true | |
}, | |
"accessAll": { | |
"type": "boolean" | |
}, | |
"externalId": { | |
"type": "string", | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"GroupResponseModelListResponseModel": { | |
"type": "object", | |
"properties": { | |
"object": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"data": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/GroupResponseModel" | |
}, | |
"nullable": true | |
}, | |
"continuationToken": { | |
"type": "string", | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"IapCheckRequestModel": { | |
"required": [ | |
"paymentMethodType" | |
], | |
"type": "object", | |
"properties": { | |
"paymentMethodType": { | |
"$ref": "#/components/schemas/PaymentMethodType" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"ImportCiphersRequestModel": { | |
"type": "object", | |
"properties": { | |
"folders": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/FolderRequestModel" | |
}, | |
"nullable": true | |
}, | |
"ciphers": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/CipherRequestModel" | |
}, | |
"nullable": true | |
}, | |
"folderRelationships": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/Int32Int32KeyValuePair" | |
}, | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"ImportOrganizationCiphersRequestModel": { | |
"type": "object", | |
"properties": { | |
"collections": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/CollectionRequestModel" | |
}, | |
"nullable": true | |
}, | |
"ciphers": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/CipherRequestModel" | |
}, | |
"nullable": true | |
}, | |
"collectionRelationships": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/Int32Int32KeyValuePair" | |
}, | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"ImportOrganizationUsersRequestModel": { | |
"type": "object", | |
"properties": { | |
"groups": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/Group" | |
}, | |
"nullable": true | |
}, | |
"users": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/User" | |
}, | |
"nullable": true | |
}, | |
"overwriteExisting": { | |
"type": "boolean" | |
}, | |
"largeImport": { | |
"type": "boolean" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"InstallationRequestModel": { | |
"required": [ | |
"email" | |
], | |
"type": "object", | |
"properties": { | |
"email": { | |
"maxLength": 256, | |
"minLength": 0, | |
"type": "string", | |
"format": "email" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"InstallationResponseModel": { | |
"type": "object", | |
"properties": { | |
"object": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"id": { | |
"type": "string", | |
"nullable": true | |
}, | |
"key": { | |
"type": "string", | |
"nullable": true | |
}, | |
"enabled": { | |
"type": "boolean" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"Int32Int32KeyValuePair": { | |
"type": "object", | |
"properties": { | |
"key": { | |
"type": "integer", | |
"format": "int32" | |
}, | |
"value": { | |
"type": "integer", | |
"format": "int32" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"KdfRequestModel": { | |
"required": [ | |
"kdf", | |
"kdfIterations", | |
"key", | |
"newMasterPasswordHash" | |
], | |
"type": "object", | |
"properties": { | |
"masterPasswordHash": { | |
"maxLength": 300, | |
"minLength": 0, | |
"type": "string", | |
"nullable": true | |
}, | |
"otp": { | |
"type": "string", | |
"nullable": true | |
}, | |
"secret": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"newMasterPasswordHash": { | |
"maxLength": 300, | |
"minLength": 0, | |
"type": "string" | |
}, | |
"key": { | |
"type": "string" | |
}, | |
"kdf": { | |
"$ref": "#/components/schemas/KdfType" | |
}, | |
"kdfIterations": { | |
"type": "integer", | |
"format": "int32" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"KdfType": { | |
"enum": [ | |
0 | |
], | |
"type": "integer", | |
"format": "int32" | |
}, | |
"KeyModel": { | |
"type": "object", | |
"properties": { | |
"name": { | |
"type": "string", | |
"nullable": true | |
}, | |
"id": { | |
"type": "integer", | |
"format": "int32" | |
}, | |
"migrated": { | |
"type": "boolean" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"KeysRequestModel": { | |
"required": [ | |
"encryptedPrivateKey" | |
], | |
"type": "object", | |
"properties": { | |
"publicKey": { | |
"type": "string", | |
"nullable": true | |
}, | |
"encryptedPrivateKey": { | |
"type": "string" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"KeysResponseModel": { | |
"type": "object", | |
"properties": { | |
"object": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"key": { | |
"type": "string", | |
"nullable": true | |
}, | |
"publicKey": { | |
"type": "string", | |
"nullable": true | |
}, | |
"privateKey": { | |
"type": "string", | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"LicenseType": { | |
"enum": [ | |
0, | |
1 | |
], | |
"type": "integer", | |
"format": "int32" | |
}, | |
"OpenIdConnectRedirectBehavior": { | |
"enum": [ | |
0, | |
1 | |
], | |
"type": "integer", | |
"format": "int32" | |
}, | |
"OrganizationApiKeyInformation": { | |
"type": "object", | |
"properties": { | |
"object": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"keyType": { | |
"$ref": "#/components/schemas/OrganizationApiKeyType" | |
}, | |
"revisionDate": { | |
"type": "string", | |
"format": "date-time" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"OrganizationApiKeyInformationListResponseModel": { | |
"type": "object", | |
"properties": { | |
"object": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"data": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/OrganizationApiKeyInformation" | |
}, | |
"nullable": true | |
}, | |
"continuationToken": { | |
"type": "string", | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"OrganizationApiKeyRequestModel": { | |
"type": "object", | |
"properties": { | |
"masterPasswordHash": { | |
"maxLength": 300, | |
"minLength": 0, | |
"type": "string", | |
"nullable": true | |
}, | |
"otp": { | |
"type": "string", | |
"nullable": true | |
}, | |
"secret": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"type": { | |
"$ref": "#/components/schemas/OrganizationApiKeyType" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"OrganizationApiKeyType": { | |
"enum": [ | |
0, | |
1 | |
], | |
"type": "integer", | |
"format": "int32" | |
}, | |
"OrganizationAutoEnrollStatusResponseModel": { | |
"type": "object", | |
"properties": { | |
"object": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"id": { | |
"type": "string", | |
"nullable": true | |
}, | |
"resetPasswordEnabled": { | |
"type": "boolean" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"OrganizationConnectionRequestModel": { | |
"type": "object", | |
"properties": { | |
"type": { | |
"$ref": "#/components/schemas/OrganizationConnectionType" | |
}, | |
"organizationId": { | |
"type": "string", | |
"format": "uuid" | |
}, | |
"enabled": { | |
"type": "boolean" | |
}, | |
"config": { | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"OrganizationConnectionResponseModel": { | |
"type": "object", | |
"properties": { | |
"id": { | |
"type": "string", | |
"format": "uuid", | |
"nullable": true | |
}, | |
"type": { | |
"$ref": "#/components/schemas/OrganizationConnectionType" | |
}, | |
"organizationId": { | |
"type": "string", | |
"format": "uuid" | |
}, | |
"enabled": { | |
"type": "boolean" | |
}, | |
"config": { | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"OrganizationConnectionType": { | |
"enum": [ | |
1 | |
], | |
"type": "integer", | |
"format": "int32" | |
}, | |
"OrganizationCreateRequestModel": { | |
"required": [ | |
"billingEmail", | |
"key", | |
"name" | |
], | |
"type": "object", | |
"properties": { | |
"name": { | |
"maxLength": 50, | |
"minLength": 0, | |
"type": "string" | |
}, | |
"businessName": { | |
"maxLength": 50, | |
"minLength": 0, | |
"type": "string", | |
"nullable": true | |
}, | |
"billingEmail": { | |
"maxLength": 256, | |
"minLength": 0, | |
"type": "string", | |
"format": "email" | |
}, | |
"planType": { | |
"$ref": "#/components/schemas/PlanType" | |
}, | |
"key": { | |
"type": "string" | |
}, | |
"keys": { | |
"$ref": "#/components/schemas/OrganizationKeysRequestModel" | |
}, | |
"paymentMethodType": { | |
"$ref": "#/components/schemas/PaymentMethodType" | |
}, | |
"paymentToken": { | |
"type": "string", | |
"nullable": true | |
}, | |
"additionalSeats": { | |
"maximum": 2147483647, | |
"minimum": 0, | |
"type": "integer", | |
"format": "int32" | |
}, | |
"additionalStorageGb": { | |
"maximum": 99, | |
"minimum": 0, | |
"type": "integer", | |
"format": "int32", | |
"nullable": true | |
}, | |
"premiumAccessAddon": { | |
"type": "boolean" | |
}, | |
"collectionName": { | |
"maxLength": 1000, | |
"minLength": 0, | |
"type": "string", | |
"nullable": true | |
}, | |
"taxIdNumber": { | |
"type": "string", | |
"nullable": true | |
}, | |
"billingAddressLine1": { | |
"type": "string", | |
"nullable": true | |
}, | |
"billingAddressLine2": { | |
"type": "string", | |
"nullable": true | |
}, | |
"billingAddressCity": { | |
"type": "string", | |
"nullable": true | |
}, | |
"billingAddressState": { | |
"type": "string", | |
"nullable": true | |
}, | |
"billingAddressPostalCode": { | |
"type": "string", | |
"nullable": true | |
}, | |
"billingAddressCountry": { | |
"maxLength": 2, | |
"minLength": 0, | |
"type": "string", | |
"nullable": true | |
}, | |
"maxAutoscaleSeats": { | |
"type": "integer", | |
"format": "int32", | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"OrganizationKeysRequestModel": { | |
"required": [ | |
"encryptedPrivateKey", | |
"publicKey" | |
], | |
"type": "object", | |
"properties": { | |
"publicKey": { | |
"type": "string" | |
}, | |
"encryptedPrivateKey": { | |
"type": "string" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"OrganizationKeysResponseModel": { | |
"type": "object", | |
"properties": { | |
"object": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"publicKey": { | |
"type": "string", | |
"nullable": true | |
}, | |
"privateKey": { | |
"type": "string", | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"OrganizationLicense": { | |
"type": "object", | |
"properties": { | |
"licenseKey": { | |
"type": "string", | |
"nullable": true | |
}, | |
"installationId": { | |
"type": "string", | |
"format": "uuid" | |
}, | |
"id": { | |
"type": "string", | |
"format": "uuid" | |
}, | |
"name": { | |
"type": "string", | |
"nullable": true | |
}, | |
"billingEmail": { | |
"type": "string", | |
"nullable": true | |
}, | |
"businessName": { | |
"type": "string", | |
"nullable": true | |
}, | |
"enabled": { | |
"type": "boolean" | |
}, | |
"plan": { | |
"type": "string", | |
"nullable": true | |
}, | |
"planType": { | |
"$ref": "#/components/schemas/PlanType" | |
}, | |
"seats": { | |
"type": "integer", | |
"format": "int32", | |
"nullable": true | |
}, | |
"maxCollections": { | |
"type": "integer", | |
"format": "int32", | |
"nullable": true | |
}, | |
"usePolicies": { | |
"type": "boolean" | |
}, | |
"useSso": { | |
"type": "boolean" | |
}, | |
"useKeyConnector": { | |
"type": "boolean" | |
}, | |
"useGroups": { | |
"type": "boolean" | |
}, | |
"useEvents": { | |
"type": "boolean" | |
}, | |
"useDirectory": { | |
"type": "boolean" | |
}, | |
"useTotp": { | |
"type": "boolean" | |
}, | |
"use2fa": { | |
"type": "boolean" | |
}, | |
"useApi": { | |
"type": "boolean" | |
}, | |
"useResetPassword": { | |
"type": "boolean" | |
}, | |
"maxStorageGb": { | |
"type": "integer", | |
"format": "int32", | |
"nullable": true | |
}, | |
"selfHost": { | |
"type": "boolean" | |
}, | |
"usersGetPremium": { | |
"type": "boolean" | |
}, | |
"version": { | |
"type": "integer", | |
"format": "int32" | |
}, | |
"issued": { | |
"type": "string", | |
"format": "date-time" | |
}, | |
"refresh": { | |
"type": "string", | |
"format": "date-time", | |
"nullable": true | |
}, | |
"expires": { | |
"type": "string", | |
"format": "date-time", | |
"nullable": true | |
}, | |
"trial": { | |
"type": "boolean" | |
}, | |
"licenseType": { | |
"$ref": "#/components/schemas/LicenseType" | |
}, | |
"hash": { | |
"type": "string", | |
"nullable": true | |
}, | |
"signature": { | |
"type": "string", | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"OrganizationResponseModel": { | |
"type": "object", | |
"properties": { | |
"object": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"id": { | |
"type": "string", | |
"nullable": true | |
}, | |
"identifier": { | |
"type": "string", | |
"nullable": true | |
}, | |
"name": { | |
"type": "string", | |
"nullable": true | |
}, | |
"businessName": { | |
"type": "string", | |
"nullable": true | |
}, | |
"businessAddress1": { | |
"type": "string", | |
"nullable": true | |
}, | |
"businessAddress2": { | |
"type": "string", | |
"nullable": true | |
}, | |
"businessAddress3": { | |
"type": "string", | |
"nullable": true | |
}, | |
"businessCountry": { | |
"type": "string", | |
"nullable": true | |
}, | |
"businessTaxNumber": { | |
"type": "string", | |
"nullable": true | |
}, | |
"billingEmail": { | |
"type": "string", | |
"nullable": true | |
}, | |
"plan": { | |
"$ref": "#/components/schemas/PlanResponseModel" | |
}, | |
"planType": { | |
"$ref": "#/components/schemas/PlanType" | |
}, | |
"seats": { | |
"type": "integer", | |
"format": "int32", | |
"nullable": true | |
}, | |
"maxAutoscaleSeats": { | |
"type": "integer", | |
"format": "int32", | |
"nullable": true | |
}, | |
"maxCollections": { | |
"type": "integer", | |
"format": "int32", | |
"nullable": true | |
}, | |
"maxStorageGb": { | |
"type": "integer", | |
"format": "int32", | |
"nullable": true | |
}, | |
"usePolicies": { | |
"type": "boolean" | |
}, | |
"useSso": { | |
"type": "boolean" | |
}, | |
"useKeyConnector": { | |
"type": "boolean" | |
}, | |
"useGroups": { | |
"type": "boolean" | |
}, | |
"useDirectory": { | |
"type": "boolean" | |
}, | |
"useEvents": { | |
"type": "boolean" | |
}, | |
"useTotp": { | |
"type": "boolean" | |
}, | |
"use2fa": { | |
"type": "boolean" | |
}, | |
"useApi": { | |
"type": "boolean" | |
}, | |
"useResetPassword": { | |
"type": "boolean" | |
}, | |
"usersGetPremium": { | |
"type": "boolean" | |
}, | |
"selfHost": { | |
"type": "boolean" | |
}, | |
"hasPublicAndPrivateKeys": { | |
"type": "boolean" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"OrganizationSeatRequestModel": { | |
"required": [ | |
"seatAdjustment" | |
], | |
"type": "object", | |
"properties": { | |
"seatAdjustment": { | |
"type": "integer", | |
"format": "int32" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"OrganizationSponsorshipCreateRequestModel": { | |
"required": [ | |
"planSponsorshipType", | |
"sponsoredEmail" | |
], | |
"type": "object", | |
"properties": { | |
"planSponsorshipType": { | |
"$ref": "#/components/schemas/PlanSponsorshipType" | |
}, | |
"sponsoredEmail": { | |
"maxLength": 256, | |
"minLength": 0, | |
"type": "string" | |
}, | |
"friendlyName": { | |
"maxLength": 256, | |
"minLength": 0, | |
"type": "string", | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"OrganizationSponsorshipRedeemRequestModel": { | |
"required": [ | |
"planSponsorshipType", | |
"sponsoredOrganizationId" | |
], | |
"type": "object", | |
"properties": { | |
"planSponsorshipType": { | |
"$ref": "#/components/schemas/PlanSponsorshipType" | |
}, | |
"sponsoredOrganizationId": { | |
"type": "string", | |
"format": "uuid" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"OrganizationSponsorshipRequestModel": { | |
"type": "object", | |
"properties": { | |
"sponsoringOrganizationUserId": { | |
"type": "string", | |
"format": "uuid" | |
}, | |
"friendlyName": { | |
"type": "string", | |
"nullable": true | |
}, | |
"offeredToEmail": { | |
"type": "string", | |
"nullable": true | |
}, | |
"planSponsorshipType": { | |
"$ref": "#/components/schemas/PlanSponsorshipType" | |
}, | |
"lastSyncDate": { | |
"type": "string", | |
"format": "date-time", | |
"nullable": true | |
}, | |
"validUntil": { | |
"type": "string", | |
"format": "date-time", | |
"nullable": true | |
}, | |
"toDelete": { | |
"type": "boolean" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"OrganizationSponsorshipResponseModel": { | |
"type": "object", | |
"properties": { | |
"sponsoringOrganizationUserId": { | |
"type": "string", | |
"format": "uuid" | |
}, | |
"friendlyName": { | |
"type": "string", | |
"nullable": true | |
}, | |
"offeredToEmail": { | |
"type": "string", | |
"nullable": true | |
}, | |
"planSponsorshipType": { | |
"$ref": "#/components/schemas/PlanSponsorshipType" | |
}, | |
"lastSyncDate": { | |
"type": "string", | |
"format": "date-time", | |
"nullable": true | |
}, | |
"validUntil": { | |
"type": "string", | |
"format": "date-time", | |
"nullable": true | |
}, | |
"toDelete": { | |
"type": "boolean" | |
}, | |
"cloudSponsorshipRemoved": { | |
"type": "boolean" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"OrganizationSponsorshipSyncRequestModel": { | |
"type": "object", | |
"properties": { | |
"billingSyncKey": { | |
"type": "string", | |
"nullable": true | |
}, | |
"sponsoringOrganizationCloudId": { | |
"type": "string", | |
"format": "uuid" | |
}, | |
"sponsorshipsBatch": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/OrganizationSponsorshipRequestModel" | |
}, | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"OrganizationSponsorshipSyncResponseModel": { | |
"type": "object", | |
"properties": { | |
"sponsorshipsBatch": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/OrganizationSponsorshipResponseModel" | |
}, | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"OrganizationSsoRequestModel": { | |
"required": [ | |
"data", | |
"enabled" | |
], | |
"type": "object", | |
"properties": { | |
"enabled": { | |
"type": "boolean" | |
}, | |
"data": { | |
"$ref": "#/components/schemas/SsoConfigurationDataRequest" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"OrganizationSsoResponseModel": { | |
"type": "object", | |
"properties": { | |
"object": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"enabled": { | |
"type": "boolean" | |
}, | |
"data": { | |
"$ref": "#/components/schemas/SsoConfigurationData" | |
}, | |
"urls": { | |
"$ref": "#/components/schemas/SsoUrls" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"OrganizationSubscriptionResponseModel": { | |
"type": "object", | |
"properties": { | |
"object": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"id": { | |
"type": "string", | |
"nullable": true | |
}, | |
"identifier": { | |
"type": "string", | |
"nullable": true | |
}, | |
"name": { | |
"type": "string", | |
"nullable": true | |
}, | |
"businessName": { | |
"type": "string", | |
"nullable": true | |
}, | |
"businessAddress1": { | |
"type": "string", | |
"nullable": true | |
}, | |
"businessAddress2": { | |
"type": "string", | |
"nullable": true | |
}, | |
"businessAddress3": { | |
"type": "string", | |
"nullable": true | |
}, | |
"businessCountry": { | |
"type": "string", | |
"nullable": true | |
}, | |
"businessTaxNumber": { | |
"type": "string", | |
"nullable": true | |
}, | |
"billingEmail": { | |
"type": "string", | |
"nullable": true | |
}, | |
"plan": { | |
"$ref": "#/components/schemas/PlanResponseModel" | |
}, | |
"planType": { | |
"$ref": "#/components/schemas/PlanType" | |
}, | |
"seats": { | |
"type": "integer", | |
"format": "int32", | |
"nullable": true | |
}, | |
"maxAutoscaleSeats": { | |
"type": "integer", | |
"format": "int32", | |
"nullable": true | |
}, | |
"maxCollections": { | |
"type": "integer", | |
"format": "int32", | |
"nullable": true | |
}, | |
"maxStorageGb": { | |
"type": "integer", | |
"format": "int32", | |
"nullable": true | |
}, | |
"usePolicies": { | |
"type": "boolean" | |
}, | |
"useSso": { | |
"type": "boolean" | |
}, | |
"useKeyConnector": { | |
"type": "boolean" | |
}, | |
"useGroups": { | |
"type": "boolean" | |
}, | |
"useDirectory": { | |
"type": "boolean" | |
}, | |
"useEvents": { | |
"type": "boolean" | |
}, | |
"useTotp": { | |
"type": "boolean" | |
}, | |
"use2fa": { | |
"type": "boolean" | |
}, | |
"useApi": { | |
"type": "boolean" | |
}, | |
"useResetPassword": { | |
"type": "boolean" | |
}, | |
"usersGetPremium": { | |
"type": "boolean" | |
}, | |
"selfHost": { | |
"type": "boolean" | |
}, | |
"hasPublicAndPrivateKeys": { | |
"type": "boolean" | |
}, | |
"storageName": { | |
"type": "string", | |
"nullable": true | |
}, | |
"storageGb": { | |
"type": "number", | |
"format": "double", | |
"nullable": true | |
}, | |
"subscription": { | |
"$ref": "#/components/schemas/BillingSubscription" | |
}, | |
"upcomingInvoice": { | |
"$ref": "#/components/schemas/BillingSubscriptionUpcomingInvoice" | |
}, | |
"expiration": { | |
"type": "string", | |
"format": "date-time", | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"OrganizationSubscriptionUpdateRequestModel": { | |
"required": [ | |
"seatAdjustment" | |
], | |
"type": "object", | |
"properties": { | |
"seatAdjustment": { | |
"type": "integer", | |
"format": "int32" | |
}, | |
"maxAutoscaleSeats": { | |
"type": "integer", | |
"format": "int32", | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"OrganizationTaxInfoUpdateRequestModel": { | |
"required": [ | |
"country" | |
], | |
"type": "object", | |
"properties": { | |
"country": { | |
"type": "string" | |
}, | |
"postalCode": { | |
"type": "string", | |
"nullable": true | |
}, | |
"taxId": { | |
"type": "string", | |
"nullable": true | |
}, | |
"line1": { | |
"type": "string", | |
"nullable": true | |
}, | |
"line2": { | |
"type": "string", | |
"nullable": true | |
}, | |
"city": { | |
"type": "string", | |
"nullable": true | |
}, | |
"state": { | |
"type": "string", | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"OrganizationUpdateRequestModel": { | |
"required": [ | |
"billingEmail", | |
"name" | |
], | |
"type": "object", | |
"properties": { | |
"name": { | |
"maxLength": 50, | |
"minLength": 0, | |
"type": "string" | |
}, | |
"businessName": { | |
"maxLength": 50, | |
"minLength": 0, | |
"type": "string", | |
"nullable": true | |
}, | |
"identifier": { | |
"maxLength": 50, | |
"minLength": 0, | |
"type": "string", | |
"nullable": true | |
}, | |
"billingEmail": { | |
"maxLength": 256, | |
"minLength": 0, | |
"type": "string", | |
"format": "email" | |
}, | |
"permissions": { | |
"$ref": "#/components/schemas/Permissions" | |
}, | |
"keys": { | |
"$ref": "#/components/schemas/OrganizationKeysRequestModel" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"OrganizationUpgradeRequestModel": { | |
"type": "object", | |
"properties": { | |
"businessName": { | |
"maxLength": 50, | |
"minLength": 0, | |
"type": "string", | |
"nullable": true | |
}, | |
"planType": { | |
"$ref": "#/components/schemas/PlanType" | |
}, | |
"additionalSeats": { | |
"maximum": 2147483647, | |
"minimum": 0, | |
"type": "integer", | |
"format": "int32" | |
}, | |
"additionalStorageGb": { | |
"maximum": 99, | |
"minimum": 0, | |
"type": "integer", | |
"format": "int32", | |
"nullable": true | |
}, | |
"premiumAccessAddon": { | |
"type": "boolean" | |
}, | |
"billingAddressCountry": { | |
"type": "string", | |
"nullable": true | |
}, | |
"billingAddressPostalCode": { | |
"type": "string", | |
"nullable": true | |
}, | |
"keys": { | |
"$ref": "#/components/schemas/OrganizationKeysRequestModel" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"OrganizationUserAcceptRequestModel": { | |
"required": [ | |
"token" | |
], | |
"type": "object", | |
"properties": { | |
"token": { | |
"type": "string" | |
}, | |
"resetPasswordKey": { | |
"type": "string", | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"OrganizationUserBulkConfirmRequestModel": { | |
"required": [ | |
"keys" | |
], | |
"type": "object", | |
"properties": { | |
"keys": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/OrganizationUserBulkConfirmRequestModelEntry" | |
} | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"OrganizationUserBulkConfirmRequestModelEntry": { | |
"required": [ | |
"id", | |
"key" | |
], | |
"type": "object", | |
"properties": { | |
"id": { | |
"type": "string", | |
"format": "uuid" | |
}, | |
"key": { | |
"type": "string" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"OrganizationUserBulkRequestModel": { | |
"required": [ | |
"ids" | |
], | |
"type": "object", | |
"properties": { | |
"ids": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"format": "uuid" | |
} | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"OrganizationUserBulkResponseModel": { | |
"type": "object", | |
"properties": { | |
"object": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"id": { | |
"type": "string", | |
"format": "uuid" | |
}, | |
"error": { | |
"type": "string", | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"OrganizationUserBulkResponseModelListResponseModel": { | |
"type": "object", | |
"properties": { | |
"object": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"data": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/OrganizationUserBulkResponseModel" | |
}, | |
"nullable": true | |
}, | |
"continuationToken": { | |
"type": "string", | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"OrganizationUserConfirmRequestModel": { | |
"required": [ | |
"key" | |
], | |
"type": "object", | |
"properties": { | |
"key": { | |
"type": "string" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"OrganizationUserDetailsResponseModel": { | |
"type": "object", | |
"properties": { | |
"object": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"id": { | |
"type": "string", | |
"nullable": true | |
}, | |
"userId": { | |
"type": "string", | |
"nullable": true | |
}, | |
"type": { | |
"$ref": "#/components/schemas/OrganizationUserType" | |
}, | |
"status": { | |
"$ref": "#/components/schemas/OrganizationUserStatusType" | |
}, | |
"accessAll": { | |
"type": "boolean" | |
}, | |
"permissions": { | |
"$ref": "#/components/schemas/Permissions" | |
}, | |
"resetPasswordEnrolled": { | |
"type": "boolean" | |
}, | |
"usesKeyConnector": { | |
"type": "boolean" | |
}, | |
"collections": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/SelectionReadOnlyResponseModel" | |
}, | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"OrganizationUserInviteRequestModel": { | |
"required": [ | |
"emails", | |
"type" | |
], | |
"type": "object", | |
"properties": { | |
"emails": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"type": { | |
"$ref": "#/components/schemas/OrganizationUserType" | |
}, | |
"accessAll": { | |
"type": "boolean" | |
}, | |
"permissions": { | |
"$ref": "#/components/schemas/Permissions" | |
}, | |
"collections": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/SelectionReadOnlyRequestModel" | |
}, | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"OrganizationUserPublicKeyResponseModel": { | |
"type": "object", | |
"properties": { | |
"object": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"id": { | |
"type": "string", | |
"format": "uuid" | |
}, | |
"userId": { | |
"type": "string", | |
"format": "uuid" | |
}, | |
"key": { | |
"type": "string", | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"OrganizationUserPublicKeyResponseModelListResponseModel": { | |
"type": "object", | |
"properties": { | |
"object": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"data": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/OrganizationUserPublicKeyResponseModel" | |
}, | |
"nullable": true | |
}, | |
"continuationToken": { | |
"type": "string", | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"OrganizationUserResetPasswordDetailsResponseModel": { | |
"type": "object", | |
"properties": { | |
"object": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"kdf": { | |
"$ref": "#/components/schemas/KdfType" | |
}, | |
"kdfIterations": { | |
"type": "integer", | |
"format": "int32" | |
}, | |
"resetPasswordKey": { | |
"type": "string", | |
"nullable": true | |
}, | |
"encryptedPrivateKey": { | |
"type": "string", | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"OrganizationUserResetPasswordEnrollmentRequestModel": { | |
"type": "object", | |
"properties": { | |
"masterPasswordHash": { | |
"maxLength": 300, | |
"minLength": 0, | |
"type": "string", | |
"nullable": true | |
}, | |
"otp": { | |
"type": "string", | |
"nullable": true | |
}, | |
"secret": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"resetPasswordKey": { | |
"type": "string", | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"OrganizationUserResetPasswordRequestModel": { | |
"required": [ | |
"key", | |
"newMasterPasswordHash" | |
], | |
"type": "object", | |
"properties": { | |
"newMasterPasswordHash": { | |
"maxLength": 300, | |
"minLength": 0, | |
"type": "string" | |
}, | |
"key": { | |
"type": "string" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"OrganizationUserStatusType": { | |
"enum": [ | |
0, | |
1, | |
2, | |
-1 | |
], | |
"type": "integer", | |
"format": "int32" | |
}, | |
"OrganizationUserType": { | |
"enum": [ | |
0, | |
1, | |
2, | |
3, | |
4 | |
], | |
"type": "integer", | |
"format": "int32" | |
}, | |
"OrganizationUserUpdateGroupsRequestModel": { | |
"required": [ | |
"groupIds" | |
], | |
"type": "object", | |
"properties": { | |
"groupIds": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"OrganizationUserUpdateRequestModel": { | |
"required": [ | |
"type" | |
], | |
"type": "object", | |
"properties": { | |
"type": { | |
"$ref": "#/components/schemas/OrganizationUserType" | |
}, | |
"accessAll": { | |
"type": "boolean" | |
}, | |
"permissions": { | |
"$ref": "#/components/schemas/Permissions" | |
}, | |
"collections": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/SelectionReadOnlyRequestModel" | |
}, | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"OrganizationUserUserDetailsResponseModel": { | |
"type": "object", | |
"properties": { | |
"object": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"id": { | |
"type": "string", | |
"nullable": true | |
}, | |
"userId": { | |
"type": "string", | |
"nullable": true | |
}, | |
"type": { | |
"$ref": "#/components/schemas/OrganizationUserType" | |
}, | |
"status": { | |
"$ref": "#/components/schemas/OrganizationUserStatusType" | |
}, | |
"accessAll": { | |
"type": "boolean" | |
}, | |
"permissions": { | |
"$ref": "#/components/schemas/Permissions" | |
}, | |
"resetPasswordEnrolled": { | |
"type": "boolean" | |
}, | |
"usesKeyConnector": { | |
"type": "boolean" | |
}, | |
"name": { | |
"type": "string", | |
"nullable": true | |
}, | |
"email": { | |
"type": "string", | |
"nullable": true | |
}, | |
"twoFactorEnabled": { | |
"type": "boolean" | |
}, | |
"ssoBound": { | |
"type": "boolean" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"OrganizationUserUserDetailsResponseModelListResponseModel": { | |
"type": "object", | |
"properties": { | |
"object": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"data": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/OrganizationUserUserDetailsResponseModel" | |
}, | |
"nullable": true | |
}, | |
"continuationToken": { | |
"type": "string", | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"OrganizationVerifyBankRequestModel": { | |
"required": [ | |
"amount1", | |
"amount2" | |
], | |
"type": "object", | |
"properties": { | |
"amount1": { | |
"maximum": 99, | |
"minimum": 1, | |
"type": "integer", | |
"format": "int32" | |
}, | |
"amount2": { | |
"maximum": 99, | |
"minimum": 1, | |
"type": "integer", | |
"format": "int32" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"PasswordHintRequestModel": { | |
"required": [ | |
"email" | |
], | |
"type": "object", | |
"properties": { | |
"email": { | |
"maxLength": 256, | |
"minLength": 0, | |
"type": "string", | |
"format": "email" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"PasswordRequestModel": { | |
"required": [ | |
"key", | |
"newMasterPasswordHash" | |
], | |
"type": "object", | |
"properties": { | |
"masterPasswordHash": { | |
"maxLength": 300, | |
"minLength": 0, | |
"type": "string", | |
"nullable": true | |
}, | |
"otp": { | |
"type": "string", | |
"nullable": true | |
}, | |
"secret": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"newMasterPasswordHash": { | |
"maxLength": 300, | |
"minLength": 0, | |
"type": "string" | |
}, | |
"key": { | |
"type": "string" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"PaymentMethodType": { | |
"enum": [ | |
0, | |
1, | |
2, | |
3, | |
4, | |
5, | |
6, | |
7, | |
8, | |
255 | |
], | |
"type": "integer", | |
"format": "int32" | |
}, | |
"PaymentRequestModel": { | |
"required": [ | |
"country", | |
"paymentMethodType", | |
"paymentToken" | |
], | |
"type": "object", | |
"properties": { | |
"country": { | |
"type": "string" | |
}, | |
"postalCode": { | |
"type": "string", | |
"nullable": true | |
}, | |
"taxId": { | |
"type": "string", | |
"nullable": true | |
}, | |
"line1": { | |
"type": "string", | |
"nullable": true | |
}, | |
"line2": { | |
"type": "string", | |
"nullable": true | |
}, | |
"city": { | |
"type": "string", | |
"nullable": true | |
}, | |
"state": { | |
"type": "string", | |
"nullable": true | |
}, | |
"paymentMethodType": { | |
"$ref": "#/components/schemas/PaymentMethodType" | |
}, | |
"paymentToken": { | |
"type": "string" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"PaymentResponseModel": { | |
"type": "object", | |
"properties": { | |
"object": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"userProfile": { | |
"$ref": "#/components/schemas/ProfileResponseModel" | |
}, | |
"paymentIntentClientSecret": { | |
"type": "string", | |
"nullable": true | |
}, | |
"success": { | |
"type": "boolean" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"Permissions": { | |
"type": "object", | |
"properties": { | |
"accessEventLogs": { | |
"type": "boolean" | |
}, | |
"accessImportExport": { | |
"type": "boolean" | |
}, | |
"accessReports": { | |
"type": "boolean" | |
}, | |
"manageAllCollections": { | |
"type": "boolean", | |
"readOnly": true, | |
"deprecated": true | |
}, | |
"createNewCollections": { | |
"type": "boolean" | |
}, | |
"editAnyCollection": { | |
"type": "boolean" | |
}, | |
"deleteAnyCollection": { | |
"type": "boolean" | |
}, | |
"manageAssignedCollections": { | |
"type": "boolean", | |
"readOnly": true, | |
"deprecated": true | |
}, | |
"editAssignedCollections": { | |
"type": "boolean" | |
}, | |
"deleteAssignedCollections": { | |
"type": "boolean" | |
}, | |
"manageGroups": { | |
"type": "boolean" | |
}, | |
"managePolicies": { | |
"type": "boolean" | |
}, | |
"manageSso": { | |
"type": "boolean" | |
}, | |
"manageUsers": { | |
"type": "boolean" | |
}, | |
"manageResetPassword": { | |
"type": "boolean" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"PlanResponseModel": { | |
"type": "object", | |
"properties": { | |
"object": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"type": { | |
"$ref": "#/components/schemas/PlanType" | |
}, | |
"product": { | |
"$ref": "#/components/schemas/ProductType" | |
}, | |
"name": { | |
"type": "string", | |
"nullable": true | |
}, | |
"isAnnual": { | |
"type": "boolean" | |
}, | |
"nameLocalizationKey": { | |
"type": "string", | |
"nullable": true | |
}, | |
"descriptionLocalizationKey": { | |
"type": "string", | |
"nullable": true | |
}, | |
"canBeUsedByBusiness": { | |
"type": "boolean" | |
}, | |
"baseSeats": { | |
"type": "integer", | |
"format": "int32" | |
}, | |
"baseStorageGb": { | |
"type": "integer", | |
"format": "int32", | |
"nullable": true | |
}, | |
"maxCollections": { | |
"type": "integer", | |
"format": "int32", | |
"nullable": true | |
}, | |
"maxUsers": { | |
"type": "integer", | |
"format": "int32", | |
"nullable": true | |
}, | |
"hasAdditionalSeatsOption": { | |
"type": "boolean" | |
}, | |
"maxAdditionalSeats": { | |
"type": "integer", | |
"format": "int32", | |
"nullable": true | |
}, | |
"hasAdditionalStorageOption": { | |
"type": "boolean" | |
}, | |
"maxAdditionalStorage": { | |
"type": "integer", | |
"format": "int32", | |
"nullable": true | |
}, | |
"hasPremiumAccessOption": { | |
"type": "boolean" | |
}, | |
"trialPeriodDays": { | |
"type": "integer", | |
"format": "int32", | |
"nullable": true | |
}, | |
"hasSelfHost": { | |
"type": "boolean" | |
}, | |
"hasPolicies": { | |
"type": "boolean" | |
}, | |
"hasGroups": { | |
"type": "boolean" | |
}, | |
"hasDirectory": { | |
"type": "boolean" | |
}, | |
"hasEvents": { | |
"type": "boolean" | |
}, | |
"hasTotp": { | |
"type": "boolean" | |
}, | |
"has2fa": { | |
"type": "boolean" | |
}, | |
"hasApi": { | |
"type": "boolean" | |
}, | |
"hasSso": { | |
"type": "boolean" | |
}, | |
"hasResetPassword": { | |
"type": "boolean" | |
}, | |
"usersGetPremium": { | |
"type": "boolean" | |
}, | |
"upgradeSortOrder": { | |
"type": "integer", | |
"format": "int32" | |
}, | |
"displaySortOrder": { | |
"type": "integer", | |
"format": "int32" | |
}, | |
"legacyYear": { | |
"type": "integer", | |
"format": "int32", | |
"nullable": true | |
}, | |
"disabled": { | |
"type": "boolean" | |
}, | |
"stripePlanId": { | |
"type": "string", | |
"nullable": true | |
}, | |
"stripeSeatPlanId": { | |
"type": "string", | |
"nullable": true | |
}, | |
"stripeStoragePlanId": { | |
"type": "string", | |
"nullable": true | |
}, | |
"stripePremiumAccessPlanId": { | |
"type": "string", | |
"nullable": true | |
}, | |
"basePrice": { | |
"type": "number", | |
"format": "double" | |
}, | |
"seatPrice": { | |
"type": "number", | |
"format": "double" | |
}, | |
"additionalStoragePricePerGb": { | |
"type": "number", | |
"format": "double" | |
}, | |
"premiumAccessOptionPrice": { | |
"type": "number", | |
"format": "double" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"PlanResponseModelListResponseModel": { | |
"type": "object", | |
"properties": { | |
"object": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"data": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/PlanResponseModel" | |
}, | |
"nullable": true | |
}, | |
"continuationToken": { | |
"type": "string", | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"PlanSponsorshipType": { | |
"enum": [ | |
0 | |
], | |
"type": "integer", | |
"format": "int32" | |
}, | |
"PlanType": { | |
"enum": [ | |
0, | |
1, | |
2, | |
3, | |
4, | |
5, | |
6, | |
7, | |
8, | |
9, | |
10, | |
11 | |
], | |
"type": "integer", | |
"format": "int32" | |
}, | |
"PolicyRequestModel": { | |
"required": [ | |
"enabled", | |
"type" | |
], | |
"type": "object", | |
"properties": { | |
"type": { | |
"$ref": "#/components/schemas/PolicyType" | |
}, | |
"enabled": { | |
"type": "boolean" | |
}, | |
"data": { | |
"type": "object", | |
"additionalProperties": { | |
"nullable": true | |
}, | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"PolicyResponseModel": { | |
"type": "object", | |
"properties": { | |
"object": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"id": { | |
"type": "string", | |
"nullable": true | |
}, | |
"organizationId": { | |
"type": "string", | |
"nullable": true | |
}, | |
"type": { | |
"$ref": "#/components/schemas/PolicyType" | |
}, | |
"data": { | |
"type": "object", | |
"additionalProperties": { | |
"nullable": true | |
}, | |
"nullable": true | |
}, | |
"enabled": { | |
"type": "boolean" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"PolicyResponseModelListResponseModel": { | |
"type": "object", | |
"properties": { | |
"object": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"data": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/PolicyResponseModel" | |
}, | |
"nullable": true | |
}, | |
"continuationToken": { | |
"type": "string", | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"PolicyType": { | |
"enum": [ | |
0, | |
1, | |
2, | |
3, | |
4, | |
5, | |
6, | |
7, | |
8, | |
9, | |
10 | |
], | |
"type": "integer", | |
"format": "int32" | |
}, | |
"PreloginRequestModel": { | |
"required": [ | |
"email" | |
], | |
"type": "object", | |
"properties": { | |
"email": { | |
"maxLength": 256, | |
"minLength": 0, | |
"type": "string", | |
"format": "email" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"PreloginResponseModel": { | |
"type": "object", | |
"properties": { | |
"kdf": { | |
"$ref": "#/components/schemas/KdfType" | |
}, | |
"kdfIterations": { | |
"type": "integer", | |
"format": "int32" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"ProductType": { | |
"enum": [ | |
0, | |
1, | |
2, | |
3 | |
], | |
"type": "integer", | |
"format": "int32" | |
}, | |
"ProfileOrganizationResponseModel": { | |
"type": "object", | |
"properties": { | |
"object": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"id": { | |
"type": "string", | |
"nullable": true | |
}, | |
"name": { | |
"type": "string", | |
"nullable": true | |
}, | |
"usePolicies": { | |
"type": "boolean" | |
}, | |
"useSso": { | |
"type": "boolean" | |
}, | |
"useKeyConnector": { | |
"type": "boolean" | |
}, | |
"useGroups": { | |
"type": "boolean" | |
}, | |
"useDirectory": { | |
"type": "boolean" | |
}, | |
"useEvents": { | |
"type": "boolean" | |
}, | |
"useTotp": { | |
"type": "boolean" | |
}, | |
"use2fa": { | |
"type": "boolean" | |
}, | |
"useApi": { | |
"type": "boolean" | |
}, | |
"useResetPassword": { | |
"type": "boolean" | |
}, | |
"usersGetPremium": { | |
"type": "boolean" | |
}, | |
"selfHost": { | |
"type": "boolean" | |
}, | |
"seats": { | |
"type": "integer", | |
"format": "int32", | |
"nullable": true | |
}, | |
"maxCollections": { | |
"type": "integer", | |
"format": "int32", | |
"nullable": true | |
}, | |
"maxStorageGb": { | |
"type": "integer", | |
"format": "int32", | |
"nullable": true | |
}, | |
"key": { | |
"type": "string", | |
"nullable": true | |
}, | |
"status": { | |
"$ref": "#/components/schemas/OrganizationUserStatusType" | |
}, | |
"type": { | |
"$ref": "#/components/schemas/OrganizationUserType" | |
}, | |
"enabled": { | |
"type": "boolean" | |
}, | |
"ssoBound": { | |
"type": "boolean" | |
}, | |
"identifier": { | |
"type": "string", | |
"nullable": true | |
}, | |
"permissions": { | |
"$ref": "#/components/schemas/Permissions" | |
}, | |
"resetPasswordEnrolled": { | |
"type": "boolean" | |
}, | |
"userId": { | |
"type": "string", | |
"nullable": true | |
}, | |
"hasPublicAndPrivateKeys": { | |
"type": "boolean" | |
}, | |
"providerId": { | |
"type": "string", | |
"nullable": true | |
}, | |
"providerName": { | |
"type": "string", | |
"nullable": true | |
}, | |
"familySponsorshipFriendlyName": { | |
"type": "string", | |
"nullable": true | |
}, | |
"familySponsorshipAvailable": { | |
"type": "boolean" | |
}, | |
"planProductType": { | |
"$ref": "#/components/schemas/ProductType" | |
}, | |
"keyConnectorEnabled": { | |
"type": "boolean" | |
}, | |
"keyConnectorUrl": { | |
"type": "string", | |
"nullable": true | |
}, | |
"familySponsorshipLastSyncDate": { | |
"type": "string", | |
"format": "date-time", | |
"nullable": true | |
}, | |
"familySponsorshipValidUntil": { | |
"type": "string", | |
"format": "date-time", | |
"nullable": true | |
}, | |
"familySponsorshipToDelete": { | |
"type": "boolean", | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"ProfileOrganizationResponseModelListResponseModel": { | |
"type": "object", | |
"properties": { | |
"object": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"data": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/ProfileOrganizationResponseModel" | |
}, | |
"nullable": true | |
}, | |
"continuationToken": { | |
"type": "string", | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"ProfileProviderOrganizationResponseModel": { | |
"type": "object", | |
"properties": { | |
"object": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"id": { | |
"type": "string", | |
"nullable": true | |
}, | |
"name": { | |
"type": "string", | |
"nullable": true | |
}, | |
"usePolicies": { | |
"type": "boolean" | |
}, | |
"useSso": { | |
"type": "boolean" | |
}, | |
"useKeyConnector": { | |
"type": "boolean" | |
}, | |
"useGroups": { | |
"type": "boolean" | |
}, | |
"useDirectory": { | |
"type": "boolean" | |
}, | |
"useEvents": { | |
"type": "boolean" | |
}, | |
"useTotp": { | |
"type": "boolean" | |
}, | |
"use2fa": { | |
"type": "boolean" | |
}, | |
"useApi": { | |
"type": "boolean" | |
}, | |
"useResetPassword": { | |
"type": "boolean" | |
}, | |
"usersGetPremium": { | |
"type": "boolean" | |
}, | |
"selfHost": { | |
"type": "boolean" | |
}, | |
"seats": { | |
"type": "integer", | |
"format": "int32", | |
"nullable": true | |
}, | |
"maxCollections": { | |
"type": "integer", | |
"format": "int32", | |
"nullable": true | |
}, | |
"maxStorageGb": { | |
"type": "integer", | |
"format": "int32", | |
"nullable": true | |
}, | |
"key": { | |
"type": "string", | |
"nullable": true | |
}, | |
"status": { | |
"$ref": "#/components/schemas/OrganizationUserStatusType" | |
}, | |
"type": { | |
"$ref": "#/components/schemas/OrganizationUserType" | |
}, | |
"enabled": { | |
"type": "boolean" | |
}, | |
"ssoBound": { | |
"type": "boolean" | |
}, | |
"identifier": { | |
"type": "string", | |
"nullable": true | |
}, | |
"permissions": { | |
"$ref": "#/components/schemas/Permissions" | |
}, | |
"resetPasswordEnrolled": { | |
"type": "boolean" | |
}, | |
"userId": { | |
"type": "string", | |
"nullable": true | |
}, | |
"hasPublicAndPrivateKeys": { | |
"type": "boolean" | |
}, | |
"providerId": { | |
"type": "string", | |
"nullable": true | |
}, | |
"providerName": { | |
"type": "string", | |
"nullable": true | |
}, | |
"familySponsorshipFriendlyName": { | |
"type": "string", | |
"nullable": true | |
}, | |
"familySponsorshipAvailable": { | |
"type": "boolean" | |
}, | |
"planProductType": { | |
"$ref": "#/components/schemas/ProductType" | |
}, | |
"keyConnectorEnabled": { | |
"type": "boolean" | |
}, | |
"keyConnectorUrl": { | |
"type": "string", | |
"nullable": true | |
}, | |
"familySponsorshipLastSyncDate": { | |
"type": "string", | |
"format": "date-time", | |
"nullable": true | |
}, | |
"familySponsorshipValidUntil": { | |
"type": "string", | |
"format": "date-time", | |
"nullable": true | |
}, | |
"familySponsorshipToDelete": { | |
"type": "boolean", | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"ProfileProviderResponseModel": { | |
"type": "object", | |
"properties": { | |
"object": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"id": { | |
"type": "string", | |
"nullable": true | |
}, | |
"name": { | |
"type": "string", | |
"nullable": true | |
}, | |
"key": { | |
"type": "string", | |
"nullable": true | |
}, | |
"status": { | |
"$ref": "#/components/schemas/ProviderUserStatusType" | |
}, | |
"type": { | |
"$ref": "#/components/schemas/ProviderUserType" | |
}, | |
"enabled": { | |
"type": "boolean" | |
}, | |
"permissions": { | |
"$ref": "#/components/schemas/Permissions" | |
}, | |
"userId": { | |
"type": "string", | |
"nullable": true | |
}, | |
"useEvents": { | |
"type": "boolean" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"ProfileResponseModel": { | |
"type": "object", | |
"properties": { | |
"object": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"id": { | |
"type": "string", | |
"nullable": true | |
}, | |
"name": { | |
"type": "string", | |
"nullable": true | |
}, | |
"email": { | |
"type": "string", | |
"nullable": true | |
}, | |
"emailVerified": { | |
"type": "boolean" | |
}, | |
"premium": { | |
"type": "boolean" | |
}, | |
"premiumFromOrganization": { | |
"type": "boolean" | |
}, | |
"masterPasswordHint": { | |
"type": "string", | |
"nullable": true | |
}, | |
"culture": { | |
"type": "string", | |
"nullable": true | |
}, | |
"twoFactorEnabled": { | |
"type": "boolean" | |
}, | |
"key": { | |
"type": "string", | |
"nullable": true | |
}, | |
"privateKey": { | |
"type": "string", | |
"nullable": true | |
}, | |
"securityStamp": { | |
"type": "string", | |
"nullable": true | |
}, | |
"forcePasswordReset": { | |
"type": "boolean" | |
}, | |
"usesKeyConnector": { | |
"type": "boolean" | |
}, | |
"organizations": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/ProfileOrganizationResponseModel" | |
}, | |
"nullable": true | |
}, | |
"providers": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/ProfileProviderResponseModel" | |
}, | |
"nullable": true | |
}, | |
"providerOrganizations": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/ProfileProviderOrganizationResponseModel" | |
}, | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"ProviderOrganizationAddRequestModel": { | |
"required": [ | |
"key", | |
"organizationId" | |
], | |
"type": "object", | |
"properties": { | |
"organizationId": { | |
"type": "string", | |
"format": "uuid" | |
}, | |
"key": { | |
"type": "string" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"ProviderOrganizationCreateRequestModel": { | |
"required": [ | |
"clientOwnerEmail", | |
"organizationCreateRequest" | |
], | |
"type": "object", | |
"properties": { | |
"clientOwnerEmail": { | |
"maxLength": 256, | |
"minLength": 0, | |
"type": "string" | |
}, | |
"organizationCreateRequest": { | |
"$ref": "#/components/schemas/OrganizationCreateRequestModel" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"ProviderOrganizationOrganizationDetailsResponseModel": { | |
"type": "object", | |
"properties": { | |
"object": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"id": { | |
"type": "string", | |
"format": "uuid" | |
}, | |
"providerId": { | |
"type": "string", | |
"format": "uuid" | |
}, | |
"organizationId": { | |
"type": "string", | |
"format": "uuid" | |
}, | |
"key": { | |
"type": "string", | |
"nullable": true | |
}, | |
"settings": { | |
"type": "string", | |
"nullable": true | |
}, | |
"creationDate": { | |
"type": "string", | |
"format": "date-time" | |
}, | |
"revisionDate": { | |
"type": "string", | |
"format": "date-time" | |
}, | |
"organizationName": { | |
"type": "string", | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"ProviderOrganizationOrganizationDetailsResponseModelListResponseModel": { | |
"type": "object", | |
"properties": { | |
"object": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"data": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/ProviderOrganizationOrganizationDetailsResponseModel" | |
}, | |
"nullable": true | |
}, | |
"continuationToken": { | |
"type": "string", | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"ProviderOrganizationResponseModel": { | |
"type": "object", | |
"properties": { | |
"object": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"id": { | |
"type": "string", | |
"format": "uuid" | |
}, | |
"providerId": { | |
"type": "string", | |
"format": "uuid" | |
}, | |
"organizationId": { | |
"type": "string", | |
"format": "uuid" | |
}, | |
"key": { | |
"type": "string", | |
"nullable": true | |
}, | |
"settings": { | |
"type": "string", | |
"nullable": true | |
}, | |
"creationDate": { | |
"type": "string", | |
"format": "date-time" | |
}, | |
"revisionDate": { | |
"type": "string", | |
"format": "date-time" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"ProviderResponseModel": { | |
"type": "object", | |
"properties": { | |
"object": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"id": { | |
"type": "string", | |
"format": "uuid" | |
}, | |
"name": { | |
"type": "string", | |
"nullable": true | |
}, | |
"businessName": { | |
"type": "string", | |
"nullable": true | |
}, | |
"businessAddress1": { | |
"type": "string", | |
"nullable": true | |
}, | |
"businessAddress2": { | |
"type": "string", | |
"nullable": true | |
}, | |
"businessAddress3": { | |
"type": "string", | |
"nullable": true | |
}, | |
"businessCountry": { | |
"type": "string", | |
"nullable": true | |
}, | |
"businessTaxNumber": { | |
"type": "string", | |
"nullable": true | |
}, | |
"billingEmail": { | |
"type": "string", | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"ProviderSetupRequestModel": { | |
"required": [ | |
"billingEmail", | |
"key", | |
"name", | |
"token" | |
], | |
"type": "object", | |
"properties": { | |
"name": { | |
"maxLength": 50, | |
"minLength": 0, | |
"type": "string" | |
}, | |
"businessName": { | |
"maxLength": 50, | |
"minLength": 0, | |
"type": "string", | |
"nullable": true | |
}, | |
"billingEmail": { | |
"maxLength": 256, | |
"minLength": 0, | |
"type": "string", | |
"format": "email" | |
}, | |
"token": { | |
"type": "string" | |
}, | |
"key": { | |
"type": "string" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"ProviderUpdateRequestModel": { | |
"required": [ | |
"billingEmail", | |
"name" | |
], | |
"type": "object", | |
"properties": { | |
"name": { | |
"maxLength": 50, | |
"minLength": 0, | |
"type": "string" | |
}, | |
"businessName": { | |
"maxLength": 50, | |
"minLength": 0, | |
"type": "string", | |
"nullable": true | |
}, | |
"billingEmail": { | |
"maxLength": 256, | |
"minLength": 0, | |
"type": "string", | |
"format": "email" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"ProviderUserAcceptRequestModel": { | |
"required": [ | |
"token" | |
], | |
"type": "object", | |
"properties": { | |
"token": { | |
"type": "string" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"ProviderUserBulkConfirmRequestModel": { | |
"required": [ | |
"keys" | |
], | |
"type": "object", | |
"properties": { | |
"keys": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/ProviderUserBulkConfirmRequestModelEntry" | |
} | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"ProviderUserBulkConfirmRequestModelEntry": { | |
"required": [ | |
"id", | |
"key" | |
], | |
"type": "object", | |
"properties": { | |
"id": { | |
"type": "string", | |
"format": "uuid" | |
}, | |
"key": { | |
"type": "string" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"ProviderUserBulkRequestModel": { | |
"required": [ | |
"ids" | |
], | |
"type": "object", | |
"properties": { | |
"ids": { | |
"type": "array", | |
"items": { | |
"type": "string", | |
"format": "uuid" | |
} | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"ProviderUserBulkResponseModel": { | |
"type": "object", | |
"properties": { | |
"object": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"id": { | |
"type": "string", | |
"format": "uuid" | |
}, | |
"error": { | |
"type": "string", | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"ProviderUserBulkResponseModelListResponseModel": { | |
"type": "object", | |
"properties": { | |
"object": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"data": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/ProviderUserBulkResponseModel" | |
}, | |
"nullable": true | |
}, | |
"continuationToken": { | |
"type": "string", | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"ProviderUserConfirmRequestModel": { | |
"required": [ | |
"key" | |
], | |
"type": "object", | |
"properties": { | |
"key": { | |
"type": "string" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"ProviderUserInviteRequestModel": { | |
"required": [ | |
"emails", | |
"type" | |
], | |
"type": "object", | |
"properties": { | |
"emails": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"type": { | |
"$ref": "#/components/schemas/ProviderUserType" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"ProviderUserPublicKeyResponseModel": { | |
"type": "object", | |
"properties": { | |
"object": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"id": { | |
"type": "string", | |
"format": "uuid" | |
}, | |
"userId": { | |
"type": "string", | |
"format": "uuid" | |
}, | |
"key": { | |
"type": "string", | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"ProviderUserPublicKeyResponseModelListResponseModel": { | |
"type": "object", | |
"properties": { | |
"object": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"data": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/ProviderUserPublicKeyResponseModel" | |
}, | |
"nullable": true | |
}, | |
"continuationToken": { | |
"type": "string", | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"ProviderUserResponseModel": { | |
"type": "object", | |
"properties": { | |
"object": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"id": { | |
"type": "string", | |
"nullable": true | |
}, | |
"userId": { | |
"type": "string", | |
"nullable": true | |
}, | |
"type": { | |
"$ref": "#/components/schemas/ProviderUserType" | |
}, | |
"status": { | |
"$ref": "#/components/schemas/ProviderUserStatusType" | |
}, | |
"permissions": { | |
"$ref": "#/components/schemas/Permissions" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"ProviderUserStatusType": { | |
"enum": [ | |
0, | |
1, | |
2 | |
], | |
"type": "integer", | |
"format": "int32" | |
}, | |
"ProviderUserType": { | |
"enum": [ | |
0, | |
1 | |
], | |
"type": "integer", | |
"format": "int32" | |
}, | |
"ProviderUserUpdateRequestModel": { | |
"required": [ | |
"type" | |
], | |
"type": "object", | |
"properties": { | |
"type": { | |
"$ref": "#/components/schemas/ProviderUserType" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"ProviderUserUserDetailsResponseModel": { | |
"type": "object", | |
"properties": { | |
"object": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"id": { | |
"type": "string", | |
"nullable": true | |
}, | |
"userId": { | |
"type": "string", | |
"nullable": true | |
}, | |
"type": { | |
"$ref": "#/components/schemas/ProviderUserType" | |
}, | |
"status": { | |
"$ref": "#/components/schemas/ProviderUserStatusType" | |
}, | |
"permissions": { | |
"$ref": "#/components/schemas/Permissions" | |
}, | |
"name": { | |
"type": "string", | |
"nullable": true | |
}, | |
"email": { | |
"type": "string", | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"ProviderUserUserDetailsResponseModelListResponseModel": { | |
"type": "object", | |
"properties": { | |
"object": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"data": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/ProviderUserUserDetailsResponseModel" | |
}, | |
"nullable": true | |
}, | |
"continuationToken": { | |
"type": "string", | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"PubKeyCredParam": { | |
"type": "object", | |
"properties": { | |
"type": { | |
"$ref": "#/components/schemas/PublicKeyCredentialType" | |
}, | |
"alg": { | |
"$ref": "#/components/schemas/Algorithm" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"PublicKeyCredentialDescriptor": { | |
"type": "object", | |
"properties": { | |
"type": { | |
"$ref": "#/components/schemas/PublicKeyCredentialType" | |
}, | |
"id": { | |
"type": "string", | |
"format": "byte", | |
"nullable": true | |
}, | |
"transports": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/AuthenticatorTransport" | |
}, | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"PublicKeyCredentialRpEntity": { | |
"type": "object", | |
"properties": { | |
"id": { | |
"type": "string", | |
"nullable": true | |
}, | |
"name": { | |
"type": "string", | |
"nullable": true | |
}, | |
"icon": { | |
"type": "string", | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"PublicKeyCredentialType": { | |
"enum": [ | |
"public-key" | |
], | |
"type": "string" | |
}, | |
"PushRegistrationRequestModel": { | |
"required": [ | |
"deviceId", | |
"identifier", | |
"pushToken", | |
"type", | |
"userId" | |
], | |
"type": "object", | |
"properties": { | |
"deviceId": { | |
"type": "string" | |
}, | |
"pushToken": { | |
"type": "string" | |
}, | |
"userId": { | |
"type": "string" | |
}, | |
"type": { | |
"$ref": "#/components/schemas/DeviceType" | |
}, | |
"identifier": { | |
"type": "string" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"PushSendRequestModel": { | |
"required": [ | |
"payload", | |
"type" | |
], | |
"type": "object", | |
"properties": { | |
"userId": { | |
"type": "string", | |
"nullable": true | |
}, | |
"organizationId": { | |
"type": "string", | |
"nullable": true | |
}, | |
"deviceId": { | |
"type": "string", | |
"nullable": true | |
}, | |
"identifier": { | |
"type": "string", | |
"nullable": true | |
}, | |
"type": { | |
"$ref": "#/components/schemas/PushType" | |
}, | |
"payload": { } | |
}, | |
"additionalProperties": false | |
}, | |
"PushType": { | |
"enum": [ | |
0, | |
1, | |
2, | |
3, | |
4, | |
5, | |
6, | |
7, | |
8, | |
9, | |
10, | |
11, | |
12, | |
13, | |
14 | |
], | |
"type": "integer", | |
"format": "int32" | |
}, | |
"PushUpdateRequestModel": { | |
"required": [ | |
"deviceIds", | |
"organizationId" | |
], | |
"type": "object", | |
"properties": { | |
"deviceIds": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"organizationId": { | |
"type": "string" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"RegisterRequestModel": { | |
"required": [ | |
"email", | |
"masterPasswordHash" | |
], | |
"type": "object", | |
"properties": { | |
"name": { | |
"maxLength": 50, | |
"minLength": 0, | |
"type": "string", | |
"nullable": true | |
}, | |
"email": { | |
"maxLength": 256, | |
"minLength": 0, | |
"type": "string" | |
}, | |
"masterPasswordHash": { | |
"maxLength": 1000, | |
"minLength": 0, | |
"type": "string" | |
}, | |
"masterPasswordHint": { | |
"maxLength": 50, | |
"minLength": 0, | |
"type": "string", | |
"nullable": true | |
}, | |
"captchaResponse": { | |
"type": "string", | |
"nullable": true | |
}, | |
"key": { | |
"type": "string", | |
"nullable": true | |
}, | |
"keys": { | |
"$ref": "#/components/schemas/KeysRequestModel" | |
}, | |
"token": { | |
"type": "string", | |
"nullable": true | |
}, | |
"organizationUserId": { | |
"type": "string", | |
"format": "uuid", | |
"nullable": true | |
}, | |
"kdf": { | |
"$ref": "#/components/schemas/KdfType" | |
}, | |
"kdfIterations": { | |
"type": "integer", | |
"format": "int32", | |
"nullable": true | |
}, | |
"referenceData": { | |
"type": "object", | |
"additionalProperties": { | |
"nullable": true | |
}, | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"ResponseData": { | |
"type": "object", | |
"properties": { | |
"attestationObject": { | |
"type": "string", | |
"format": "byte", | |
"nullable": true | |
}, | |
"clientDataJSON": { | |
"type": "string", | |
"format": "byte", | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"Saml2BindingType": { | |
"enum": [ | |
1, | |
2 | |
], | |
"type": "integer", | |
"format": "int32" | |
}, | |
"Saml2NameIdFormat": { | |
"enum": [ | |
0, | |
1, | |
2, | |
3, | |
4, | |
5, | |
6, | |
7, | |
8 | |
], | |
"type": "integer", | |
"format": "int32" | |
}, | |
"Saml2SigningBehavior": { | |
"enum": [ | |
0, | |
1, | |
3 | |
], | |
"type": "integer", | |
"format": "int32" | |
}, | |
"SecretVerificationRequestModel": { | |
"type": "object", | |
"properties": { | |
"masterPasswordHash": { | |
"maxLength": 300, | |
"minLength": 0, | |
"type": "string", | |
"nullable": true | |
}, | |
"otp": { | |
"type": "string", | |
"nullable": true | |
}, | |
"secret": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"SecureNoteType": { | |
"enum": [ | |
0 | |
], | |
"type": "integer", | |
"format": "int32" | |
}, | |
"SelectionReadOnlyRequestModel": { | |
"required": [ | |
"id" | |
], | |
"type": "object", | |
"properties": { | |
"id": { | |
"type": "string" | |
}, | |
"readOnly": { | |
"type": "boolean" | |
}, | |
"hidePasswords": { | |
"type": "boolean" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"SelectionReadOnlyResponseModel": { | |
"type": "object", | |
"properties": { | |
"id": { | |
"type": "string", | |
"nullable": true | |
}, | |
"readOnly": { | |
"type": "boolean" | |
}, | |
"hidePasswords": { | |
"type": "boolean" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"SendAccessRequestModel": { | |
"type": "object", | |
"properties": { | |
"password": { | |
"maxLength": 300, | |
"minLength": 0, | |
"type": "string", | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"SendFileModel": { | |
"type": "object", | |
"properties": { | |
"id": { | |
"type": "string", | |
"nullable": true | |
}, | |
"fileName": { | |
"maxLength": 1000, | |
"minLength": 0, | |
"type": "string", | |
"nullable": true | |
}, | |
"size": { | |
"type": "integer", | |
"format": "int64", | |
"nullable": true | |
}, | |
"sizeName": { | |
"type": "string", | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"SendFileUploadDataResponseModel": { | |
"type": "object", | |
"properties": { | |
"object": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"url": { | |
"type": "string", | |
"nullable": true | |
}, | |
"fileUploadType": { | |
"$ref": "#/components/schemas/FileUploadType" | |
}, | |
"sendResponse": { | |
"$ref": "#/components/schemas/SendResponseModel" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"SendRequestModel": { | |
"required": [ | |
"deletionDate", | |
"disabled", | |
"key" | |
], | |
"type": "object", | |
"properties": { | |
"type": { | |
"$ref": "#/components/schemas/SendType" | |
}, | |
"fileLength": { | |
"type": "integer", | |
"format": "int64", | |
"nullable": true | |
}, | |
"name": { | |
"maxLength": 1000, | |
"minLength": 0, | |
"type": "string", | |
"nullable": true | |
}, | |
"notes": { | |
"maxLength": 1000, | |
"minLength": 0, | |
"type": "string", | |
"nullable": true | |
}, | |
"key": { | |
"maxLength": 1000, | |
"minLength": 0, | |
"type": "string" | |
}, | |
"maxAccessCount": { | |
"maximum": 2147483647, | |
"minimum": 1, | |
"type": "integer", | |
"format": "int32", | |
"nullable": true | |
}, | |
"expirationDate": { | |
"type": "string", | |
"format": "date-time", | |
"nullable": true | |
}, | |
"deletionDate": { | |
"type": "string", | |
"format": "date-time" | |
}, | |
"file": { | |
"$ref": "#/components/schemas/SendFileModel" | |
}, | |
"text": { | |
"$ref": "#/components/schemas/SendTextModel" | |
}, | |
"password": { | |
"maxLength": 1000, | |
"minLength": 0, | |
"type": "string", | |
"nullable": true | |
}, | |
"disabled": { | |
"type": "boolean" | |
}, | |
"hideEmail": { | |
"type": "boolean", | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"SendResponseModel": { | |
"type": "object", | |
"properties": { | |
"object": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"id": { | |
"type": "string", | |
"nullable": true | |
}, | |
"accessId": { | |
"type": "string", | |
"nullable": true | |
}, | |
"type": { | |
"$ref": "#/components/schemas/SendType" | |
}, | |
"name": { | |
"type": "string", | |
"nullable": true | |
}, | |
"notes": { | |
"type": "string", | |
"nullable": true | |
}, | |
"file": { | |
"$ref": "#/components/schemas/SendFileModel" | |
}, | |
"text": { | |
"$ref": "#/components/schemas/SendTextModel" | |
}, | |
"key": { | |
"type": "string", | |
"nullable": true | |
}, | |
"maxAccessCount": { | |
"type": "integer", | |
"format": "int32", | |
"nullable": true | |
}, | |
"accessCount": { | |
"type": "integer", | |
"format": "int32" | |
}, | |
"password": { | |
"type": "string", | |
"nullable": true | |
}, | |
"disabled": { | |
"type": "boolean" | |
}, | |
"revisionDate": { | |
"type": "string", | |
"format": "date-time" | |
}, | |
"expirationDate": { | |
"type": "string", | |
"format": "date-time", | |
"nullable": true | |
}, | |
"deletionDate": { | |
"type": "string", | |
"format": "date-time" | |
}, | |
"hideEmail": { | |
"type": "boolean" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"SendResponseModelListResponseModel": { | |
"type": "object", | |
"properties": { | |
"object": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"data": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/SendResponseModel" | |
}, | |
"nullable": true | |
}, | |
"continuationToken": { | |
"type": "string", | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"SendTextModel": { | |
"type": "object", | |
"properties": { | |
"text": { | |
"maxLength": 1000, | |
"minLength": 0, | |
"type": "string", | |
"nullable": true | |
}, | |
"hidden": { | |
"type": "boolean" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"SendType": { | |
"enum": [ | |
0, | |
1 | |
], | |
"type": "integer", | |
"format": "int32" | |
}, | |
"SendWithIdRequestModel": { | |
"required": [ | |
"deletionDate", | |
"disabled", | |
"id", | |
"key" | |
], | |
"type": "object", | |
"properties": { | |
"type": { | |
"$ref": "#/components/schemas/SendType" | |
}, | |
"fileLength": { | |
"type": "integer", | |
"format": "int64", | |
"nullable": true | |
}, | |
"name": { | |
"maxLength": 1000, | |
"minLength": 0, | |
"type": "string", | |
"nullable": true | |
}, | |
"notes": { | |
"maxLength": 1000, | |
"minLength": 0, | |
"type": "string", | |
"nullable": true | |
}, | |
"key": { | |
"maxLength": 1000, | |
"minLength": 0, | |
"type": "string" | |
}, | |
"maxAccessCount": { | |
"maximum": 2147483647, | |
"minimum": 1, | |
"type": "integer", | |
"format": "int32", | |
"nullable": true | |
}, | |
"expirationDate": { | |
"type": "string", | |
"format": "date-time", | |
"nullable": true | |
}, | |
"deletionDate": { | |
"type": "string", | |
"format": "date-time" | |
}, | |
"file": { | |
"$ref": "#/components/schemas/SendFileModel" | |
}, | |
"text": { | |
"$ref": "#/components/schemas/SendTextModel" | |
}, | |
"password": { | |
"maxLength": 1000, | |
"minLength": 0, | |
"type": "string", | |
"nullable": true | |
}, | |
"disabled": { | |
"type": "boolean" | |
}, | |
"hideEmail": { | |
"type": "boolean", | |
"nullable": true | |
}, | |
"id": { | |
"type": "string", | |
"format": "uuid" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"SetKeyConnectorKeyRequestModel": { | |
"required": [ | |
"kdf", | |
"kdfIterations", | |
"key", | |
"keys", | |
"orgIdentifier" | |
], | |
"type": "object", | |
"properties": { | |
"key": { | |
"type": "string" | |
}, | |
"keys": { | |
"$ref": "#/components/schemas/KeysRequestModel" | |
}, | |
"kdf": { | |
"$ref": "#/components/schemas/KdfType" | |
}, | |
"kdfIterations": { | |
"type": "integer", | |
"format": "int32" | |
}, | |
"orgIdentifier": { | |
"type": "string" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"SetPasswordRequestModel": { | |
"required": [ | |
"kdf", | |
"kdfIterations", | |
"key", | |
"keys", | |
"masterPasswordHash" | |
], | |
"type": "object", | |
"properties": { | |
"masterPasswordHash": { | |
"maxLength": 300, | |
"minLength": 0, | |
"type": "string" | |
}, | |
"key": { | |
"type": "string" | |
}, | |
"masterPasswordHint": { | |
"maxLength": 50, | |
"minLength": 0, | |
"type": "string", | |
"nullable": true | |
}, | |
"keys": { | |
"$ref": "#/components/schemas/KeysRequestModel" | |
}, | |
"kdf": { | |
"$ref": "#/components/schemas/KdfType" | |
}, | |
"kdfIterations": { | |
"type": "integer", | |
"format": "int32" | |
}, | |
"orgIdentifier": { | |
"type": "string", | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"SsoConfigurationData": { | |
"type": "object", | |
"properties": { | |
"configType": { | |
"$ref": "#/components/schemas/SsoType" | |
}, | |
"keyConnectorEnabled": { | |
"type": "boolean" | |
}, | |
"keyConnectorUrl": { | |
"type": "string", | |
"nullable": true | |
}, | |
"authority": { | |
"type": "string", | |
"nullable": true | |
}, | |
"clientId": { | |
"type": "string", | |
"nullable": true | |
}, | |
"clientSecret": { | |
"type": "string", | |
"nullable": true | |
}, | |
"metadataAddress": { | |
"type": "string", | |
"nullable": true | |
}, | |
"redirectBehavior": { | |
"$ref": "#/components/schemas/OpenIdConnectRedirectBehavior" | |
}, | |
"getClaimsFromUserInfoEndpoint": { | |
"type": "boolean" | |
}, | |
"additionalScopes": { | |
"type": "string", | |
"nullable": true | |
}, | |
"additionalUserIdClaimTypes": { | |
"type": "string", | |
"nullable": true | |
}, | |
"additionalEmailClaimTypes": { | |
"type": "string", | |
"nullable": true | |
}, | |
"additionalNameClaimTypes": { | |
"type": "string", | |
"nullable": true | |
}, | |
"acrValues": { | |
"type": "string", | |
"nullable": true | |
}, | |
"expectedReturnAcrValue": { | |
"type": "string", | |
"nullable": true | |
}, | |
"idpEntityId": { | |
"type": "string", | |
"nullable": true | |
}, | |
"idpSingleSignOnServiceUrl": { | |
"type": "string", | |
"nullable": true | |
}, | |
"idpSingleLogoutServiceUrl": { | |
"type": "string", | |
"nullable": true | |
}, | |
"idpX509PublicCert": { | |
"type": "string", | |
"nullable": true | |
}, | |
"idpBindingType": { | |
"$ref": "#/components/schemas/Saml2BindingType" | |
}, | |
"idpAllowUnsolicitedAuthnResponse": { | |
"type": "boolean" | |
}, | |
"idpArtifactResolutionServiceUrl": { | |
"type": "string", | |
"nullable": true | |
}, | |
"idpDisableOutboundLogoutRequests": { | |
"type": "boolean" | |
}, | |
"idpOutboundSigningAlgorithm": { | |
"type": "string", | |
"nullable": true | |
}, | |
"idpWantAuthnRequestsSigned": { | |
"type": "boolean" | |
}, | |
"spNameIdFormat": { | |
"$ref": "#/components/schemas/Saml2NameIdFormat" | |
}, | |
"spOutboundSigningAlgorithm": { | |
"type": "string", | |
"nullable": true | |
}, | |
"spSigningBehavior": { | |
"$ref": "#/components/schemas/Saml2SigningBehavior" | |
}, | |
"spWantAssertionsSigned": { | |
"type": "boolean" | |
}, | |
"spValidateCertificates": { | |
"type": "boolean" | |
}, | |
"spMinIncomingSigningAlgorithm": { | |
"type": "string", | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"SsoConfigurationDataRequest": { | |
"required": [ | |
"configType" | |
], | |
"type": "object", | |
"properties": { | |
"configType": { | |
"$ref": "#/components/schemas/SsoType" | |
}, | |
"keyConnectorEnabled": { | |
"type": "boolean" | |
}, | |
"keyConnectorUrl": { | |
"type": "string", | |
"nullable": true | |
}, | |
"authority": { | |
"type": "string", | |
"nullable": true | |
}, | |
"clientId": { | |
"type": "string", | |
"nullable": true | |
}, | |
"clientSecret": { | |
"type": "string", | |
"nullable": true | |
}, | |
"metadataAddress": { | |
"type": "string", | |
"nullable": true | |
}, | |
"redirectBehavior": { | |
"$ref": "#/components/schemas/OpenIdConnectRedirectBehavior" | |
}, | |
"getClaimsFromUserInfoEndpoint": { | |
"type": "boolean", | |
"nullable": true | |
}, | |
"additionalScopes": { | |
"type": "string", | |
"nullable": true | |
}, | |
"additionalUserIdClaimTypes": { | |
"type": "string", | |
"nullable": true | |
}, | |
"additionalEmailClaimTypes": { | |
"type": "string", | |
"nullable": true | |
}, | |
"additionalNameClaimTypes": { | |
"type": "string", | |
"nullable": true | |
}, | |
"acrValues": { | |
"type": "string", | |
"nullable": true | |
}, | |
"expectedReturnAcrValue": { | |
"type": "string", | |
"nullable": true | |
}, | |
"spNameIdFormat": { | |
"$ref": "#/components/schemas/Saml2NameIdFormat" | |
}, | |
"spOutboundSigningAlgorithm": { | |
"type": "string", | |
"nullable": true | |
}, | |
"spSigningBehavior": { | |
"$ref": "#/components/schemas/Saml2SigningBehavior" | |
}, | |
"spWantAssertionsSigned": { | |
"type": "boolean", | |
"nullable": true | |
}, | |
"spValidateCertificates": { | |
"type": "boolean", | |
"nullable": true | |
}, | |
"spMinIncomingSigningAlgorithm": { | |
"type": "string", | |
"nullable": true | |
}, | |
"idpEntityId": { | |
"type": "string", | |
"nullable": true | |
}, | |
"idpBindingType": { | |
"$ref": "#/components/schemas/Saml2BindingType" | |
}, | |
"idpSingleSignOnServiceUrl": { | |
"type": "string", | |
"nullable": true | |
}, | |
"idpSingleLogoutServiceUrl": { | |
"type": "string", | |
"nullable": true | |
}, | |
"idpArtifactResolutionServiceUrl": { | |
"type": "string", | |
"nullable": true | |
}, | |
"idpX509PublicCert": { | |
"type": "string", | |
"nullable": true | |
}, | |
"idpOutboundSigningAlgorithm": { | |
"type": "string", | |
"nullable": true | |
}, | |
"idpAllowUnsolicitedAuthnResponse": { | |
"type": "boolean", | |
"nullable": true | |
}, | |
"idpDisableOutboundLogoutRequests": { | |
"type": "boolean", | |
"nullable": true | |
}, | |
"idpWantAuthnRequestsSigned": { | |
"type": "boolean", | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"SsoType": { | |
"enum": [ | |
1, | |
2 | |
], | |
"type": "integer", | |
"format": "int32" | |
}, | |
"SsoUrls": { | |
"type": "object", | |
"properties": { | |
"callbackPath": { | |
"type": "string", | |
"nullable": true | |
}, | |
"signedOutCallbackPath": { | |
"type": "string", | |
"nullable": true | |
}, | |
"spEntityId": { | |
"type": "string", | |
"nullable": true | |
}, | |
"spMetadataUrl": { | |
"type": "string", | |
"nullable": true | |
}, | |
"spAcsUrl": { | |
"type": "string", | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"StorageRequestModel": { | |
"required": [ | |
"storageGbAdjustment" | |
], | |
"type": "object", | |
"properties": { | |
"storageGbAdjustment": { | |
"type": "integer", | |
"format": "int32" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"SubscriptionResponseModel": { | |
"type": "object", | |
"properties": { | |
"object": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"storageName": { | |
"type": "string", | |
"nullable": true | |
}, | |
"storageGb": { | |
"type": "number", | |
"format": "double", | |
"nullable": true | |
}, | |
"maxStorageGb": { | |
"type": "integer", | |
"format": "int32", | |
"nullable": true | |
}, | |
"upcomingInvoice": { | |
"$ref": "#/components/schemas/BillingSubscriptionUpcomingInvoice" | |
}, | |
"subscription": { | |
"$ref": "#/components/schemas/BillingSubscription" | |
}, | |
"license": { | |
"$ref": "#/components/schemas/UserLicense" | |
}, | |
"expiration": { | |
"type": "string", | |
"format": "date-time", | |
"nullable": true | |
}, | |
"usingInAppPurchase": { | |
"type": "boolean" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"SyncResponseModel": { | |
"type": "object", | |
"properties": { | |
"object": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"profile": { | |
"$ref": "#/components/schemas/ProfileResponseModel" | |
}, | |
"folders": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/FolderResponseModel" | |
}, | |
"nullable": true | |
}, | |
"collections": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/CollectionDetailsResponseModel" | |
}, | |
"nullable": true | |
}, | |
"ciphers": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/CipherDetailsResponseModel" | |
}, | |
"nullable": true | |
}, | |
"domains": { | |
"$ref": "#/components/schemas/DomainsResponseModel" | |
}, | |
"policies": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/PolicyResponseModel" | |
}, | |
"nullable": true | |
}, | |
"sends": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/SendResponseModel" | |
}, | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"TaxInfoResponseModel": { | |
"type": "object", | |
"properties": { | |
"taxIdNumber": { | |
"type": "string", | |
"nullable": true | |
}, | |
"taxIdType": { | |
"type": "string", | |
"nullable": true | |
}, | |
"line1": { | |
"type": "string", | |
"nullable": true | |
}, | |
"line2": { | |
"type": "string", | |
"nullable": true | |
}, | |
"city": { | |
"type": "string", | |
"nullable": true | |
}, | |
"state": { | |
"type": "string", | |
"nullable": true | |
}, | |
"postalCode": { | |
"type": "string", | |
"nullable": true | |
}, | |
"country": { | |
"type": "string", | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"TaxInfoUpdateRequestModel": { | |
"required": [ | |
"country" | |
], | |
"type": "object", | |
"properties": { | |
"country": { | |
"type": "string" | |
}, | |
"postalCode": { | |
"type": "string", | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"TaxRateResponseModel": { | |
"type": "object", | |
"properties": { | |
"object": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"id": { | |
"type": "string", | |
"nullable": true | |
}, | |
"country": { | |
"type": "string", | |
"nullable": true | |
}, | |
"state": { | |
"type": "string", | |
"nullable": true | |
}, | |
"postalCode": { | |
"type": "string", | |
"nullable": true | |
}, | |
"rate": { | |
"type": "number", | |
"format": "double" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"TaxRateResponseModelListResponseModel": { | |
"type": "object", | |
"properties": { | |
"object": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"data": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/TaxRateResponseModel" | |
}, | |
"nullable": true | |
}, | |
"continuationToken": { | |
"type": "string", | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"TransactionType": { | |
"enum": [ | |
0, | |
1, | |
2, | |
3, | |
4 | |
], | |
"type": "integer", | |
"format": "int32" | |
}, | |
"TwoFactorAuthenticatorResponseModel": { | |
"type": "object", | |
"properties": { | |
"object": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"enabled": { | |
"type": "boolean" | |
}, | |
"key": { | |
"type": "string", | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"TwoFactorDuoResponseModel": { | |
"type": "object", | |
"properties": { | |
"object": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"enabled": { | |
"type": "boolean" | |
}, | |
"host": { | |
"type": "string", | |
"nullable": true | |
}, | |
"secretKey": { | |
"type": "string", | |
"nullable": true | |
}, | |
"integrationKey": { | |
"type": "string", | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"TwoFactorEmailRequestModel": { | |
"required": [ | |
"email" | |
], | |
"type": "object", | |
"properties": { | |
"masterPasswordHash": { | |
"maxLength": 300, | |
"minLength": 0, | |
"type": "string", | |
"nullable": true | |
}, | |
"otp": { | |
"type": "string", | |
"nullable": true | |
}, | |
"secret": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"email": { | |
"maxLength": 256, | |
"minLength": 0, | |
"type": "string", | |
"format": "email" | |
}, | |
"deviceIdentifier": { | |
"type": "string", | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"TwoFactorEmailResponseModel": { | |
"type": "object", | |
"properties": { | |
"object": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"enabled": { | |
"type": "boolean" | |
}, | |
"email": { | |
"type": "string", | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"TwoFactorProviderRequestModel": { | |
"required": [ | |
"type" | |
], | |
"type": "object", | |
"properties": { | |
"masterPasswordHash": { | |
"maxLength": 300, | |
"minLength": 0, | |
"type": "string", | |
"nullable": true | |
}, | |
"otp": { | |
"type": "string", | |
"nullable": true | |
}, | |
"secret": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"type": { | |
"$ref": "#/components/schemas/TwoFactorProviderType" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"TwoFactorProviderResponseModel": { | |
"type": "object", | |
"properties": { | |
"object": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"enabled": { | |
"type": "boolean" | |
}, | |
"type": { | |
"$ref": "#/components/schemas/TwoFactorProviderType" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"TwoFactorProviderResponseModelListResponseModel": { | |
"type": "object", | |
"properties": { | |
"object": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"data": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/TwoFactorProviderResponseModel" | |
}, | |
"nullable": true | |
}, | |
"continuationToken": { | |
"type": "string", | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"TwoFactorProviderType": { | |
"enum": [ | |
0, | |
1, | |
2, | |
3, | |
4, | |
5, | |
6, | |
7 | |
], | |
"type": "integer", | |
"format": "int32" | |
}, | |
"TwoFactorRecoverResponseModel": { | |
"type": "object", | |
"properties": { | |
"object": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"code": { | |
"type": "string", | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"TwoFactorRecoveryRequestModel": { | |
"required": [ | |
"email", | |
"recoveryCode" | |
], | |
"type": "object", | |
"properties": { | |
"masterPasswordHash": { | |
"maxLength": 300, | |
"minLength": 0, | |
"type": "string", | |
"nullable": true | |
}, | |
"otp": { | |
"type": "string", | |
"nullable": true | |
}, | |
"secret": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"email": { | |
"maxLength": 256, | |
"minLength": 0, | |
"type": "string", | |
"format": "email" | |
}, | |
"deviceIdentifier": { | |
"type": "string", | |
"nullable": true | |
}, | |
"recoveryCode": { | |
"maxLength": 32, | |
"minLength": 0, | |
"type": "string" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"TwoFactorWebAuthnDeleteRequestModel": { | |
"required": [ | |
"id" | |
], | |
"type": "object", | |
"properties": { | |
"masterPasswordHash": { | |
"maxLength": 300, | |
"minLength": 0, | |
"type": "string", | |
"nullable": true | |
}, | |
"otp": { | |
"type": "string", | |
"nullable": true | |
}, | |
"secret": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"id": { | |
"type": "integer", | |
"format": "int32" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"TwoFactorWebAuthnRequestModel": { | |
"required": [ | |
"deviceResponse", | |
"id" | |
], | |
"type": "object", | |
"properties": { | |
"masterPasswordHash": { | |
"maxLength": 300, | |
"minLength": 0, | |
"type": "string", | |
"nullable": true | |
}, | |
"otp": { | |
"type": "string", | |
"nullable": true | |
}, | |
"secret": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"id": { | |
"type": "integer", | |
"format": "int32" | |
}, | |
"deviceResponse": { | |
"$ref": "#/components/schemas/AuthenticatorAttestationRawResponse" | |
}, | |
"name": { | |
"type": "string", | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"TwoFactorWebAuthnResponseModel": { | |
"type": "object", | |
"properties": { | |
"object": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"enabled": { | |
"type": "boolean" | |
}, | |
"keys": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/KeyModel" | |
}, | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"TwoFactorYubiKeyResponseModel": { | |
"type": "object", | |
"properties": { | |
"object": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"enabled": { | |
"type": "boolean" | |
}, | |
"key1": { | |
"type": "string", | |
"nullable": true | |
}, | |
"key2": { | |
"type": "string", | |
"nullable": true | |
}, | |
"key3": { | |
"type": "string", | |
"nullable": true | |
}, | |
"key4": { | |
"type": "string", | |
"nullable": true | |
}, | |
"key5": { | |
"type": "string", | |
"nullable": true | |
}, | |
"nfc": { | |
"type": "boolean" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"UpdateDomainsRequestModel": { | |
"type": "object", | |
"properties": { | |
"equivalentDomains": { | |
"type": "array", | |
"items": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
} | |
}, | |
"nullable": true | |
}, | |
"excludedGlobalEquivalentDomains": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/GlobalEquivalentDomainsType" | |
}, | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"UpdateKeyRequestModel": { | |
"required": [ | |
"ciphers", | |
"folders", | |
"key", | |
"masterPasswordHash", | |
"privateKey" | |
], | |
"type": "object", | |
"properties": { | |
"masterPasswordHash": { | |
"maxLength": 300, | |
"minLength": 0, | |
"type": "string" | |
}, | |
"ciphers": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/CipherWithIdRequestModel" | |
} | |
}, | |
"folders": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/FolderWithIdRequestModel" | |
} | |
}, | |
"sends": { | |
"type": "array", | |
"items": { | |
"$ref": "#/components/schemas/SendWithIdRequestModel" | |
}, | |
"nullable": true | |
}, | |
"privateKey": { | |
"type": "string" | |
}, | |
"key": { | |
"type": "string" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"UpdateProfileRequestModel": { | |
"type": "object", | |
"properties": { | |
"name": { | |
"maxLength": 50, | |
"minLength": 0, | |
"type": "string", | |
"nullable": true | |
}, | |
"masterPasswordHint": { | |
"maxLength": 50, | |
"minLength": 0, | |
"type": "string", | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"UpdateTempPasswordRequestModel": { | |
"required": [ | |
"key", | |
"newMasterPasswordHash" | |
], | |
"type": "object", | |
"properties": { | |
"newMasterPasswordHash": { | |
"maxLength": 300, | |
"minLength": 0, | |
"type": "string" | |
}, | |
"key": { | |
"type": "string" | |
}, | |
"masterPasswordHint": { | |
"maxLength": 50, | |
"minLength": 0, | |
"type": "string", | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"UpdateTwoFactorAuthenticatorRequestModel": { | |
"required": [ | |
"key", | |
"token" | |
], | |
"type": "object", | |
"properties": { | |
"masterPasswordHash": { | |
"maxLength": 300, | |
"minLength": 0, | |
"type": "string", | |
"nullable": true | |
}, | |
"otp": { | |
"type": "string", | |
"nullable": true | |
}, | |
"secret": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"token": { | |
"maxLength": 50, | |
"minLength": 0, | |
"type": "string" | |
}, | |
"key": { | |
"maxLength": 50, | |
"minLength": 0, | |
"type": "string" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"UpdateTwoFactorDuoRequestModel": { | |
"required": [ | |
"host", | |
"integrationKey", | |
"secretKey" | |
], | |
"type": "object", | |
"properties": { | |
"masterPasswordHash": { | |
"maxLength": 300, | |
"minLength": 0, | |
"type": "string", | |
"nullable": true | |
}, | |
"otp": { | |
"type": "string", | |
"nullable": true | |
}, | |
"secret": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"integrationKey": { | |
"maxLength": 50, | |
"minLength": 0, | |
"type": "string" | |
}, | |
"secretKey": { | |
"maxLength": 50, | |
"minLength": 0, | |
"type": "string" | |
}, | |
"host": { | |
"maxLength": 50, | |
"minLength": 0, | |
"type": "string" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"UpdateTwoFactorEmailRequestModel": { | |
"required": [ | |
"email", | |
"token" | |
], | |
"type": "object", | |
"properties": { | |
"masterPasswordHash": { | |
"maxLength": 300, | |
"minLength": 0, | |
"type": "string", | |
"nullable": true | |
}, | |
"otp": { | |
"type": "string", | |
"nullable": true | |
}, | |
"secret": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"email": { | |
"maxLength": 256, | |
"minLength": 0, | |
"type": "string", | |
"format": "email" | |
}, | |
"deviceIdentifier": { | |
"type": "string", | |
"nullable": true | |
}, | |
"token": { | |
"maxLength": 50, | |
"minLength": 0, | |
"type": "string" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"UpdateTwoFactorYubicoOtpRequestModel": { | |
"required": [ | |
"nfc" | |
], | |
"type": "object", | |
"properties": { | |
"masterPasswordHash": { | |
"maxLength": 300, | |
"minLength": 0, | |
"type": "string", | |
"nullable": true | |
}, | |
"otp": { | |
"type": "string", | |
"nullable": true | |
}, | |
"secret": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"key1": { | |
"type": "string", | |
"nullable": true | |
}, | |
"key2": { | |
"type": "string", | |
"nullable": true | |
}, | |
"key3": { | |
"type": "string", | |
"nullable": true | |
}, | |
"key4": { | |
"type": "string", | |
"nullable": true | |
}, | |
"key5": { | |
"type": "string", | |
"nullable": true | |
}, | |
"nfc": { | |
"type": "boolean" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"UriMatchType": { | |
"enum": [ | |
0, | |
1, | |
2, | |
3, | |
4, | |
5 | |
], | |
"type": "integer", | |
"format": "int32" | |
}, | |
"User": { | |
"required": [ | |
"externalId" | |
], | |
"type": "object", | |
"properties": { | |
"email": { | |
"maxLength": 256, | |
"minLength": 0, | |
"type": "string", | |
"format": "email", | |
"nullable": true | |
}, | |
"deleted": { | |
"type": "boolean" | |
}, | |
"externalId": { | |
"maxLength": 300, | |
"minLength": 0, | |
"type": "string" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"UserKeyResponseModel": { | |
"type": "object", | |
"properties": { | |
"object": { | |
"type": "string", | |
"nullable": true, | |
"readOnly": true | |
}, | |
"userId": { | |
"type": "string", | |
"nullable": true | |
}, | |
"publicKey": { | |
"type": "string", | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"UserLicense": { | |
"type": "object", | |
"properties": { | |
"licenseKey": { | |
"type": "string", | |
"nullable": true | |
}, | |
"id": { | |
"type": "string", | |
"format": "uuid" | |
}, | |
"name": { | |
"type": "string", | |
"nullable": true | |
}, | |
"email": { | |
"type": "string", | |
"nullable": true | |
}, | |
"premium": { | |
"type": "boolean" | |
}, | |
"maxStorageGb": { | |
"type": "integer", | |
"format": "int32", | |
"nullable": true | |
}, | |
"version": { | |
"type": "integer", | |
"format": "int32" | |
}, | |
"issued": { | |
"type": "string", | |
"format": "date-time" | |
}, | |
"refresh": { | |
"type": "string", | |
"format": "date-time", | |
"nullable": true | |
}, | |
"expires": { | |
"type": "string", | |
"format": "date-time", | |
"nullable": true | |
}, | |
"trial": { | |
"type": "boolean" | |
}, | |
"licenseType": { | |
"$ref": "#/components/schemas/LicenseType" | |
}, | |
"hash": { | |
"type": "string", | |
"nullable": true | |
}, | |
"signature": { | |
"type": "string", | |
"nullable": true | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"UserVerificationRequirement": { | |
"enum": [ | |
"required", | |
"preferred", | |
"discouraged" | |
], | |
"type": "string" | |
}, | |
"VerifyDeleteRecoverRequestModel": { | |
"required": [ | |
"token", | |
"userId" | |
], | |
"type": "object", | |
"properties": { | |
"userId": { | |
"type": "string" | |
}, | |
"token": { | |
"type": "string" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"VerifyEmailRequestModel": { | |
"required": [ | |
"token", | |
"userId" | |
], | |
"type": "object", | |
"properties": { | |
"userId": { | |
"type": "string" | |
}, | |
"token": { | |
"type": "string" | |
} | |
}, | |
"additionalProperties": false | |
}, | |
"VerifyOTPRequestModel": { | |
"required": [ | |
"otp" | |
], | |
"type": "object", | |
"properties": { | |
"otp": { | |
"type": "string" | |
} | |
}, | |
"additionalProperties": false | |
} | |
}, | |
"securitySchemes": { | |
"OAuth2 Client Credentials": { | |
"type": "oauth2", | |
"flows": { | |
"clientCredentials": { | |
"tokenUrl": "https://identity.bitwarden.com/connect/token", | |
"scopes": { | |
"api.organization": "Organization APIs" | |
} | |
} | |
} | |
} | |
} | |
}, | |
"security": [ | |
{ | |
"OAuth2 Client Credentials": [ | |
"api.organization" | |
] | |
} | |
] | |
} |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment