{"openapi":"3.1.0","info":{"title":"app proxy","description":"Teampool App Proxy<p><a href='public/docs'>Public Documentation<a>","version":"1.0.44"},"paths":{"/token":{"post":{"tags":["authentication"],"summary":"Login For Access Token","operationId":"login_for_access_token_token_post","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/Body_login_for_access_token_token_post"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Token"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/clients":{"get":{"tags":["client management"],"summary":"Get Clients","operationId":"get_clients_clients_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Client"},"type":"array","title":"Response Get Clients Clients Get"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/mailhash/{mailHash}":{"put":{"tags":["email management"],"summary":"Create Mailhash","operationId":"create_mailhash_mailhash__mailHash__put","security":[{"OAuth2PasswordBearer":[]}],"parameters":[{"name":"mailHash","in":"path","required":true,"schema":{"type":"string","title":"Mailhash"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Mailhash"}}}},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["email management"],"summary":"Delete Mailhash","description":"Delete existing mailHash","operationId":"delete_mailhash_mailhash__mailHash__delete","security":[{"OAuth2PasswordBearer":[]}],"parameters":[{"name":"mailHash","in":"path","required":true,"schema":{"type":"string","title":"Mailhash"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["email management"],"summary":"Status Signup Process","description":"Check if mailhash is successfully validated","operationId":"status_signup_process_mailhash__mailHash__get","security":[{"OAuth2PasswordBearer":[]}],"parameters":[{"name":"mailHash","in":"path","required":true,"schema":{"type":"string","title":"Mailhash"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/password/{mailHash}":{"put":{"tags":["email management"],"summary":"Set Password","description":"set Password","operationId":"set_password_password__mailHash__put","security":[{"OAuth2PasswordBearer":[]}],"parameters":[{"name":"mailHash","in":"path","required":true,"schema":{"type":"string","title":"Mailhash"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Mailhash"}}}},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/mailhash/state/{mailHash}":{"get":{"tags":["email management"],"summary":"Status Signup Process Register","description":"Check if mailhash is successfully validated","operationId":"status_signup_process_register_mailhash_state__mailHash__get","parameters":[{"name":"mailHash","in":"path","required":true,"schema":{"type":"string","title":"Mailhash"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/mailhash_overview":{"get":{"tags":["email management"],"summary":"Get All Mailhashes","description":"Get all mailhashes","operationId":"get_all_mailhashes_mailhash_overview_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/MailhashOverview"},"type":"array","title":"Response Get All Mailhashes Mailhash Overview Get"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/messages":{"get":{"tags":["communication"],"summary":"Get Message List","description":"Get queued messages which do not have sender == 'dmz' set","operationId":"get_message_list_messages_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/message/{messageID}":{"get":{"tags":["communication"],"summary":"Get Message","operationId":"get_message_message__messageID__get","security":[{"OAuth2PasswordBearer":[]}],"parameters":[{"name":"messageID","in":"path","required":true,"schema":{"type":"string","title":"Messageid"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["communication"],"summary":"Delete Message","description":"Delete existing message","operationId":"delete_message_message__messageID__delete","security":[{"OAuth2PasswordBearer":[]}],"parameters":[{"name":"messageID","in":"path","required":true,"schema":{"type":"string","title":"Messageid"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/message":{"post":{"tags":["communication"],"summary":"Post Message","description":"post message","operationId":"post_message_message_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Message"}}},"required":true},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/messages/{userID}":{"get":{"tags":["communication"],"summary":"Get Messages For Userid","description":"Get queued messages for specific userID","operationId":"get_messages_for_userID_messages__userID__get","security":[{"OAuth2PasswordBearer":[]}],"parameters":[{"name":"userID","in":"path","required":true,"schema":{"type":"string","title":"Userid"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/users/{userID}":{"put":{"tags":["user management"],"summary":"Modify User","description":"create or modify existing user","operationId":"modify_user_users__userID__put","security":[{"OAuth2PasswordBearer":[]}],"parameters":[{"name":"userID","in":"path","required":true,"schema":{"type":"string","title":"Userid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserObject"}}}},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["user management"],"summary":"Delete User","description":"delete existing user","operationId":"delete_user_users__userID__delete","security":[{"OAuth2PasswordBearer":[]}],"parameters":[{"name":"userID","in":"path","required":true,"schema":{"type":"string","title":"Userid"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["user management"],"summary":"Get User","description":"get a specific user","operationId":"get_user_users__userID__get","security":[{"OAuth2PasswordBearer":[]}],"parameters":[{"name":"userID","in":"path","required":true,"schema":{"type":"string","title":"Userid"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserObject"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/users_overview":{"get":{"tags":["user management"],"summary":"Get All Users","description":"get existing users","operationId":"get_all_users_users_overview_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/UserObject"},"type":"array","title":"Response Get All Users Users Overview Get"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/connection/{mailHash}/{userID}":{"put":{"tags":["connection management"],"summary":"Create Connection","description":"create new mailHash <-> UserID connection","operationId":"create_connection_connection__mailHash___userID__put","security":[{"OAuth2PasswordBearer":[]}],"parameters":[{"name":"mailHash","in":"path","required":true,"schema":{"type":"string","title":"Mailhash"}},{"name":"userID","in":"path","required":true,"schema":{"type":"string","title":"Userid"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["connection management"],"summary":"Delete Connection","description":"delete existing connection","operationId":"delete_connection_connection__mailHash___userID__delete","security":[{"OAuth2PasswordBearer":[]}],"parameters":[{"name":"mailHash","in":"path","required":true,"schema":{"type":"string","title":"Mailhash"}},{"name":"userID","in":"path","required":true,"schema":{"type":"string","title":"Userid"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/connections/{mailHash}":{"get":{"tags":["connection management"],"summary":"Get Connections For Mailhash","description":"get connection endpoint(s) for mailhash","operationId":"get_connections_for_mailhash_connections__mailHash__get","parameters":[{"name":"mailHash","in":"path","required":true,"schema":{"type":"string","title":"Mailhash"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectionResult"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/connections_overview":{"get":{"tags":["connection management"],"summary":"Get All Connections","description":"get all connections","operationId":"get_all_connections_connections_overview_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Connections"},"type":"array","title":"Response Get All Connections Connections Overview Get"}}}}},"security":[{"OAuth2PasswordBearer":[]}]}},"/signup/{mailHash}":{"post":{"tags":["app"],"summary":"Signup","description":"App User Sign Up","operationId":"signup_signup__mailHash__post","parameters":[{"name":"mailHash","in":"path","required":true,"schema":{"type":"string","title":"Mailhash"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Signupdata"}}}},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/password/forget/{mailHash}":{"post":{"tags":["app"],"summary":"Forget Password","operationId":"forget_password_password_forget__mailHash__post","parameters":[{"name":"mailHash","in":"path","required":true,"schema":{"type":"string","title":"Mailhash"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/password/reset/{mailHash}":{"post":{"tags":["app"],"summary":"Reset Password","description":"App User Password Reset","operationId":"reset_password_password_reset__mailHash__post","parameters":[{"name":"mailHash","in":"path","required":true,"schema":{"type":"string","title":"Mailhash"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pwReset"}}}},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/verify/{verifytoken}":{"get":{"tags":["app"],"summary":"Verify Signup","description":"Verify Token","operationId":"verify_signup_verify__verifytoken__get","parameters":[{"name":"verifytoken","in":"path","required":true,"schema":{"type":"string","title":"Verifytoken"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/whoami/{mailHash}/{clientHash}":{"get":{"tags":["app"],"summary":"Whoami","description":"App can query user data","operationId":"whoami_whoami__mailHash___clientHash__get","security":[{"OAuth2PasswordBearer":[]}],"parameters":[{"name":"mailHash","in":"path","required":true,"schema":{"type":"string","title":"Mailhash"}},{"name":"clientHash","in":"path","required":true,"schema":{"type":"string","title":"Clienthash"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WhoAmI"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/":{"get":{"tags":["health checks"],"summary":"Redirect","operationId":"redirect__get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/status":{"get":{"tags":["health checks"],"summary":"Connectivity Check","operationId":"connectivity_check_status_get","responses":{"204":{"description":"Successful Response"}}}},"/alive":{"get":{"tags":["health checks"],"summary":"Liveness Check","operationId":"liveness_check_alive_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/ready":{"get":{"tags":["health checks"],"summary":"Readiness Check","operationId":"readiness_check_ready_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}}},"components":{"schemas":{"Body_login_for_access_token_token_post":{"properties":{"grant_type":{"anyOf":[{"type":"string","pattern":"password"},{"type":"null"}],"title":"Grant Type"},"username":{"type":"string","title":"Username"},"password":{"type":"string","title":"Password"},"scope":{"type":"string","title":"Scope","default":""},"client_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Client Id"},"client_secret":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Client Secret"}},"type":"object","required":["username","password"],"title":"Body_login_for_access_token_token_post"},"Client":{"properties":{"clientHash":{"type":"string","title":"Clienthash"},"url":{"type":"string","title":"Url"},"title":{"type":"string","title":"Title"}},"type":"object","required":["clientHash","url","title"],"title":"Client"},"ConnectionDetail":{"properties":{"title":{"type":"string","title":"Title"},"clientHash":{"type":"string","title":"Clienthash"},"url":{"type":"string","title":"Url"}},"type":"object","required":["title","clientHash","url"],"title":"ConnectionDetail"},"ConnectionResult":{"properties":{"connections":{"items":{"$ref":"#/components/schemas/ConnectionDetail"},"type":"array","title":"Connections"}},"type":"object","required":["connections"],"title":"ConnectionResult"},"Connections":{"properties":{"mailHash":{"type":"string","title":"Mailhash"},"userID":{"type":"string","title":"Userid"}},"type":"object","required":["mailHash","userID"],"title":"Connections"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"Mailhash":{"properties":{"passwordHash":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Passwordhash"},"verified":{"type":"boolean","title":"Verified","default":false}},"type":"object","title":"Mailhash"},"MailhashOverview":{"properties":{"passwordHash":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Passwordhash"},"verified":{"type":"integer","title":"Verified","default":0},"mailHash":{"type":"string","title":"Mailhash"},"userID":{"type":"string","title":"Userid"}},"type":"object","required":["mailHash"],"title":"MailhashOverview"},"Message":{"properties":{"id":{"type":"string","title":"Id"},"type":{"type":"string","title":"Type"},"userID":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Userid"},"mailHash":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mailhash"},"data":{"type":"object","title":"Data"},"sender":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sender"}},"type":"object","required":["type","data"],"title":"Message"},"Signupdata":{"properties":{"passwordHash":{"type":"string","title":"Passwordhash"}},"type":"object","required":["passwordHash"],"title":"Signupdata"},"Token":{"properties":{"access_token":{"type":"string","title":"Access Token"},"token_type":{"type":"string","title":"Token Type"}},"type":"object","required":["access_token","token_type"],"title":"Token"},"UserObject":{"properties":{"clientHash":{"type":"string","title":"Clienthash"},"forename":{"type":"string","title":"Forename"},"surname":{"type":"string","title":"Surname"},"externalID":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Externalid"},"externalClientID":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Externalclientid"},"userID":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Userid"}},"type":"object","required":["clientHash","forename","surname"],"title":"UserObject"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"WhoAmI":{"properties":{"name":{"type":"string","title":"Name"},"surname":{"type":"string","title":"Surname"},"externalID":{"type":"integer","title":"Externalid"},"externalClientID":{"type":"integer","title":"Externalclientid"},"userID":{"type":"string","title":"Userid"}},"type":"object","required":["name","surname","externalID","externalClientID","userID"],"title":"WhoAmI"},"pwReset":{"properties":{"passwordHash":{"type":"string","title":"Passwordhash"},"resetToken":{"type":"string","title":"Resettoken"}},"type":"object","required":["passwordHash","resetToken"],"title":"pwReset"}},"securitySchemes":{"OAuth2PasswordBearer":{"type":"oauth2","flows":{"password":{"scopes":{},"tokenUrl":"token"}}}}}}