{"components":{"schemas":{"AppInfo_MjgwNTkwOTUz":{"properties":{"category":{"description":"Category name (if uncertain, pick \"other\")","type":"string"},"description":{"maxLength":300,"minLength":0,"type":"string"}},"required":["category","description"],"type":"object"},"AssetKey":{"description":"S3 asset key for an icon image with retention information.","example":"3-1-47de4580-ae51-4650-acbb-d10c028cb0ac","type":"string"},"AssetSize_OTAwMDA3ODY2":{"enum":["preview","complete"],"type":"string"},"Asset_LTIyMjc1NDEz":{"properties":{"key":{"$ref":"#/components/schemas/AssetKey"},"size":{"$ref":"#/components/schemas/AssetSize_OTAwMDA3ODY2"},"type":{"$ref":"#/components/schemas/MTYxOTI3NjM3"}},"required":["key","type"],"type":"object"},"Base64ByteString":{"example":"ZXhhbXBsZQo=","type":"string"},"BaseProtocolTag_LTM0MDE1NTEx":{"enum":["proteus","mls"],"type":"string"},"CipherSuite":{"maximum":65535,"minimum":0,"type":"integer"},"ClaimKeyPackageRequest":{"properties":{"cipherSuite":{"$ref":"#/components/schemas/CipherSuite"},"claimant":{"$ref":"#/components/schemas/UUID"},"target":{"$ref":"#/components/schemas/UUID"}},"required":["claimant","target","cipherSuite"],"type":"object"},"ClientClass_NjE3MDgwNzcx":{"enum":["phone","tablet","desktop","legalhold"],"type":"string"},"ClientInfo_LTI4ODg0MTQ1":{"properties":{"id":{"description":"A 64-bit unsigned integer, represented as a hexadecimal numeral. Any valid hexadecimal numeral is accepted, but the backend will only produce representations with lowercase digits and no leading zeros","type":"string"},"mls":{"type":"boolean"},"mls_signature_key":{"example":"ZXhhbXBsZQo=","type":"string"}},"required":["id","mls"],"type":"object"},"ClientPrekey_LTcyODUzMTcw":{"properties":{"client":{"description":"A 64-bit unsigned integer, represented as a hexadecimal numeral. Any valid hexadecimal numeral is accepted, but the backend will only produce representations with lowercase digits and no leading zeros","type":"string"},"prekey":{"$ref":"#/components/schemas/UncheckedPrekeyBundle_LTU1MzQzOTgy"}},"required":["client","prekey"],"type":"object"},"Contact_LTcwODE3Mjc5":{"description":"Contact discovered through search","properties":{"accent_id":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"handle":{"type":"string"},"id":{"$ref":"#/components/schemas/UUID"},"name":{"type":"string"},"qualified_id":{"$ref":"#/components/schemas/Qualified_Id_IdTag_User_LTQ1NTIwNDM1"},"team":{"$ref":"#/components/schemas/UUID"},"type":{"$ref":"#/components/schemas/UserType_LTU1OTU4OTM5"}},"required":["qualified_id","name","type"],"type":"object"},"Domain":{"example":"example.com","type":"string"},"DomainSet":{"properties":{"domains":{"items":{"$ref":"#/components/schemas/Domain"},"type":"array","uniqueItems":true}},"required":["domains"],"type":"object"},"Email":{"type":"string"},"EmptyResponse":{"enum":["EmptyResponse"],"type":"string"},"FederatedUserSearchPolicy_MzkwODA4MTM3":{"enum":["no_search","exact_handle_search","full_search"],"type":"string"},"GetUserClients":{"properties":{"users":{"items":{"$ref":"#/components/schemas/UUID"},"type":"array"}},"required":["users"],"type":"object"},"Handle":{"type":"string"},"KeyMap_Value_MzAxODEwOTgx":{"type":"object"},"KeyPackage":{"example":"a2V5IHBhY2thZ2UgZGF0YQo=","type":"string"},"KeyPackageBundleEntry_NDQ2MzQ2MzMz":{"properties":{"client":{"description":"A 64-bit unsigned integer, represented as a hexadecimal numeral. Any valid hexadecimal numeral is accepted, but the backend will only produce representations with lowercase digits and no leading zeros","type":"string"},"domain":{"$ref":"#/components/schemas/Domain"},"key_package":{"$ref":"#/components/schemas/KeyPackage"},"key_package_ref":{"$ref":"#/components/schemas/KeyPackageRef"},"user":{"$ref":"#/components/schemas/UUID"}},"required":["domain","user","client","key_package_ref","key_package"],"type":"object"},"KeyPackageBundle_MjU2MjY0MDU2":{"properties":{"key_packages":{"items":{"$ref":"#/components/schemas/KeyPackageBundleEntry_NDQ2MzQ2MzMz"},"type":"array"}},"required":["key_packages"],"type":"object"},"KeyPackageRef":{"example":"ZXhhbXBsZQo=","type":"string"},"MLSClientsRequest":{"properties":{"cipherSuite":{"$ref":"#/components/schemas/CipherSuite"},"userId":{"$ref":"#/components/schemas/UUID"}},"required":["userId","cipherSuite"],"type":"object"},"MTYxOTI3NjM3":{"enum":["image"],"type":"string"},"NewConnectionRequest":{"properties":{"action":{"$ref":"#/components/schemas/RemoteConnectionAction"},"from":{"$ref":"#/components/schemas/UUID"},"fromTeam":{"$ref":"#/components/schemas/UUID"},"to":{"$ref":"#/components/schemas/UUID"}},"required":["from","to","action"],"type":"object"},"NewConnectionResponse":{"oneOf":[{"properties":{"tag":{"enum":["NewConnectionResponseUserNotActivated"],"type":"string"}},"required":["tag"],"title":"NewConnectionResponseUserNotActivated","type":"object"},{"properties":{"tag":{"enum":["NewConnectionResponseNotFederating"],"type":"string"}},"required":["tag"],"title":"NewConnectionResponseNotFederating","type":"object"},{"properties":{"contents":{"$ref":"#/components/schemas/RemoteConnectionAction"},"tag":{"enum":["NewConnectionResponseOk"],"type":"string"}},"required":["tag","contents"],"title":"NewConnectionResponseOk","type":"object"}]},"NonConnectedBackends":{"properties":{"nonConnectedBackends":{"items":{"$ref":"#/components/schemas/Domain"},"type":"array","uniqueItems":true}},"required":["nonConnectedBackends"],"type":"object"},"Pict_DEPRECATED_USE_ASSETS_INSTEAD":{"items":{"type":"object"},"maxItems":10,"minItems":0,"type":"array"},"PrekeyBundle_MzgzOTk4MjYz":{"properties":{"clients":{"items":{"$ref":"#/components/schemas/ClientPrekey_LTcyODUzMTcw"},"type":"array"},"user":{"$ref":"#/components/schemas/UUID"}},"required":["user","clients"],"type":"object"},"PubClient":{"properties":{"class":{"$ref":"#/components/schemas/ClientClass_NjE3MDgwNzcx"},"id":{"description":"A 64-bit unsigned integer, represented as a hexadecimal numeral. Any valid hexadecimal numeral is accepted, but the backend will only produce representations with lowercase digits and no leading zeros","type":"string"}},"required":["id"],"type":"object"},"Qualified_Id_IdTag_User_LTQ1NTIwNDM1":{"properties":{"domain":{"$ref":"#/components/schemas/Domain"},"id":{"$ref":"#/components/schemas/UUID"}},"required":["domain","id"],"type":"object"},"RemoteConnectionAction":{"enum":["RemoteConnect","RemoteRescind"],"type":"string"},"SearchRequest":{"properties":{"from":{"$ref":"#/components/schemas/UUID"},"onlyInTeams":{"items":{"$ref":"#/components/schemas/UUID"},"type":"array"},"term":{"type":"string"},"types":{"items":{"$ref":"#/components/schemas/UserTypeFilter_LTIyODQ0MjQ1"},"type":"array"}},"required":["term"],"type":"object"},"SearchResponse":{"properties":{"contacts":{"items":{"$ref":"#/components/schemas/Contact_LTcwODE3Mjc5"},"type":"array"},"searchPolicy":{"$ref":"#/components/schemas/FederatedUserSearchPolicy_MzkwODA4MTM3"}},"required":["contacts","searchPolicy"],"type":"object"},"ServiceRef_LTgxMjY3NzAz":{"properties":{"id":{"$ref":"#/components/schemas/UUID"},"provider":{"$ref":"#/components/schemas/UUID"}},"required":["id","provider"],"type":"object"},"UTCTimeMillis":{"example":"2021-05-12T10:52:02.671Z","format":"yyyy-mm-ddThh:MM:ss.qqqZ","type":"string"},"UUID":{"example":"99db9768-04e3-4b5d-9268-831b6a25c4ab","format":"uuid","type":"string"},"UncheckedPrekeyBundle_LTU1MzQzOTgy":{"properties":{"id":{"maximum":65535,"minimum":0,"type":"integer"},"key":{"type":"string"}},"required":["id","key"],"type":"object"},"UserClientPrekeyMap":{"additionalProperties":{"additionalProperties":{"properties":{"id":{"maximum":65535,"minimum":0,"type":"integer"},"key":{"type":"string"}},"required":["id","key"],"type":"object"},"type":"object"},"example":{"1d51e2d6-9c70-605f-efc8-ff85c3dabdc7":{"44901fb0712e588f":{"id":1,"key":"pQABAQECoQBYIOjl7hw0D8YRNq..."}}},"type":"object"},"UserClients":{"additionalProperties":{"items":{"description":"A 64-bit unsigned integer, represented as a hexadecimal numeral. Any valid hexadecimal numeral is accepted, but the backend will only produce representations with lowercase digits and no leading zeros","type":"string"},"type":"array"},"description":"Map of user id to list of client ids.","example":{"1d51e2d6-9c70-605f-efc8-ff85c3dabdc7":["60f85e4b15ad3786","6e323ab31554353b"]},"type":"object"},"UserDeletedConnectionsNotification":{"properties":{"connections":{"items":{"$ref":"#/components/schemas/UUID"},"type":"array"},"user":{"$ref":"#/components/schemas/UUID"}},"required":["user","connections"],"type":"object"},"UserLegalHoldStatus_LTQ2ODA2NTU5":{"description":"states whether a user is under legal hold, or whether legal hold is pending approval.","enum":["enabled","pending","disabled","no_consent"],"type":"string"},"UserMap_Set_PubClient":{"additionalProperties":{"items":{"$ref":"#/components/schemas/PubClient"},"type":"array","uniqueItems":true},"description":"Map of UserId to (Set PubClient)","example":{"1d51e2d6-9c70-605f-efc8-ff85c3dabdc7":[{"class":"legalhold","id":"d0"}]},"type":"object"},"UserProfile_LTQzMTQxMTE1":{"properties":{"accent_id":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"app":{"$ref":"#/components/schemas/AppInfo_MjgwNTkwOTUz"},"assets":{"items":{"$ref":"#/components/schemas/Asset_LTIyMjc1NDEz"},"type":"array"},"deleted":{"type":"boolean"},"email":{"$ref":"#/components/schemas/Email"},"expires_at":{"$ref":"#/components/schemas/UTCTimeMillis"},"handle":{"$ref":"#/components/schemas/Handle"},"id":{"$ref":"#/components/schemas/UUID"},"legalhold_status":{"$ref":"#/components/schemas/UserLegalHoldStatus_LTQ2ODA2NTU5"},"name":{"maxLength":128,"minLength":1,"type":"string"},"picture":{"$ref":"#/components/schemas/Pict_DEPRECATED_USE_ASSETS_INSTEAD"},"qualified_id":{"$ref":"#/components/schemas/Qualified_Id_IdTag_User_LTQ1NTIwNDM1"},"searchable":{"type":"boolean"},"service":{"$ref":"#/components/schemas/ServiceRef_LTgxMjY3NzAz"},"supported_protocols":{"items":{"$ref":"#/components/schemas/BaseProtocolTag_LTM0MDE1NTEx"},"type":"array"},"team":{"$ref":"#/components/schemas/UUID"},"text_status":{"maxLength":256,"minLength":1,"type":"string"},"type":{"$ref":"#/components/schemas/UserType_LTU1OTU4OTM5"}},"required":["qualified_id","name","accent_id","legalhold_status"],"type":"object"},"UserTypeFilter_LTIyODQ0MjQ1":{"enum":["regular","app"],"type":"string"},"UserType_LTU1OTU4OTM5":{"enum":["regular","app","bot"],"type":"string"},"VersionInfo_Njc3MjMzMjgw":{"example":{"supported":[0,1],"supported_versions":[0,1,2,3]},"properties":{"supported":{"items":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"type":"array"},"supported_versions":{"items":{"maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"type":"array"}},"required":["supported"],"type":"object"}}},"info":{"title":"Wire-Server Federation API (brig)","version":""},"openapi":"3.0.0","paths":{"/api-version":{"post":{"description":" [<a href=\"https://docs.wire.com/developer/developer/servant.html#named-and-internal-route-ids\">internal route ID:</a> \"api-version\"]\n\nAll federated endpoints expect origin domain header: `Wire-Origin-Domain`","operationId":"api-version","requestBody":{"content":{"application/json;charset=utf-8":{"schema":{"example":[],"items":{},"maxItems":0,"type":"array"}}},"required":true},"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/VersionInfo_Njc3MjMzMjgw"}}},"description":""},"400":{"description":"Invalid `body`"}},"tags":["brig"]}},"/claim-key-packages":{"post":{"description":" [<a href=\"https://docs.wire.com/developer/developer/servant.html#named-and-internal-route-ids\">internal route ID:</a> \"claim-key-packages\"]\n\nAll federated endpoints expect origin domain header: `Wire-Origin-Domain`","operationId":"claim-key-packages","requestBody":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/ClaimKeyPackageRequest"}}},"required":true},"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/KeyPackageBundle_MjU2MjY0MDU2"}}},"description":""},"400":{"description":"Invalid `body`"}},"tags":["brig"]}},"/claim-multi-prekey-bundle":{"post":{"description":" [<a href=\"https://docs.wire.com/developer/developer/servant.html#named-and-internal-route-ids\">internal route ID:</a> \"claim-multi-prekey-bundle\"]\n\nAll federated endpoints expect origin domain header: `Wire-Origin-Domain`","operationId":"claim-multi-prekey-bundle","requestBody":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/UserClients"}}},"required":true},"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/UserClientPrekeyMap"}}},"description":""},"400":{"description":"Invalid `body`"}},"tags":["brig"]}},"/claim-prekey":{"post":{"description":" [<a href=\"https://docs.wire.com/developer/developer/servant.html#named-and-internal-route-ids\">internal route ID:</a> \"claim-prekey\"]\n\nAll federated endpoints expect origin domain header: `Wire-Origin-Domain`","operationId":"claim-prekey","requestBody":{"content":{"application/json;charset=utf-8":{"schema":{"items":[{"$ref":"#/components/schemas/UUID"},{"description":"A 64-bit unsigned integer, represented as a hexadecimal numeral. Any valid hexadecimal numeral is accepted, but the backend will only produce representations with lowercase digits and no leading zeros","type":"string"}],"maxItems":2,"minItems":2,"type":"array"}}},"required":true},"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/ClientPrekey_LTcyODUzMTcw"}}},"description":""},"400":{"description":"Invalid `body`"}},"tags":["brig"]}},"/claim-prekey-bundle":{"post":{"description":" [<a href=\"https://docs.wire.com/developer/developer/servant.html#named-and-internal-route-ids\">internal route ID:</a> \"claim-prekey-bundle\"]\n\nAll federated endpoints expect origin domain header: `Wire-Origin-Domain`","operationId":"claim-prekey-bundle","requestBody":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/UUID"}}},"required":true},"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/PrekeyBundle_MzgzOTk4MjYz"}}},"description":""},"400":{"description":"Invalid `body`"}},"tags":["brig"]}},"/get-mls-clients":{"post":{"description":" [<a href=\"https://docs.wire.com/developer/developer/servant.html#named-and-internal-route-ids\">internal route ID:</a> \"get-mls-clients\"]\n\nAll federated endpoints expect origin domain header: `Wire-Origin-Domain`","operationId":"get-mls-clients","requestBody":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/MLSClientsRequest"}}},"required":true},"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"items":{"$ref":"#/components/schemas/ClientInfo_LTI4ODg0MTQ1"},"type":"array","uniqueItems":true}}},"description":""},"400":{"description":"Invalid `body`"}},"tags":["brig"]}},"/get-not-fully-connected-backends":{"post":{"description":" [<a href=\"https://docs.wire.com/developer/developer/servant.html#named-and-internal-route-ids\">internal route ID:</a> \"get-not-fully-connected-backends\"]\n\nAll federated endpoints expect origin domain header: `Wire-Origin-Domain`","operationId":"get-not-fully-connected-backends","requestBody":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/DomainSet"}}},"required":true},"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/NonConnectedBackends"}}},"description":""},"400":{"description":"Invalid `body`"}},"tags":["brig"]}},"/get-user-by-handle":{"post":{"description":" [<a href=\"https://docs.wire.com/developer/developer/servant.html#named-and-internal-route-ids\">internal route ID:</a> \"get-user-by-handle\"]\n\nAll federated endpoints expect origin domain header: `Wire-Origin-Domain`","operationId":"get-user-by-handle","requestBody":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/Handle"}}},"required":true},"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/UserProfile_LTQzMTQxMTE1"}}},"description":""},"400":{"description":"Invalid `body`"}},"tags":["brig"]}},"/get-user-clients":{"post":{"description":" [<a href=\"https://docs.wire.com/developer/developer/servant.html#named-and-internal-route-ids\">internal route ID:</a> \"get-user-clients\"]\n\nAll federated endpoints expect origin domain header: `Wire-Origin-Domain`","operationId":"get-user-clients","requestBody":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/GetUserClients"}}},"required":true},"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/UserMap_Set_PubClient"}}},"description":""},"400":{"description":"Invalid `body`"}},"tags":["brig"]}},"/get-users-by-ids":{"post":{"description":" [<a href=\"https://docs.wire.com/developer/developer/servant.html#named-and-internal-route-ids\">internal route ID:</a> \"get-users-by-ids\"]\n\nAll federated endpoints expect origin domain header: `Wire-Origin-Domain`","operationId":"get-users-by-ids","requestBody":{"content":{"application/json;charset=utf-8":{"schema":{"items":{"$ref":"#/components/schemas/UUID"},"type":"array"}}},"required":true},"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"items":{"$ref":"#/components/schemas/UserProfile_LTQzMTQxMTE1"},"type":"array"}}},"description":""},"400":{"description":"Invalid `body`"}},"tags":["brig"]}},"/on-user-deleted-connections":{"post":{"description":" [<a href=\"https://docs.wire.com/developer/developer/servant.html#named-and-internal-route-ids\">internal route ID:</a> \"on-user-deleted-connections\"]\n\nAll federated endpoints expect origin domain header: `Wire-Origin-Domain`","operationId":"on-user-deleted-connections","requestBody":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/UserDeletedConnectionsNotification"}}},"required":true},"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/EmptyResponse"}}},"description":""},"400":{"description":"Invalid `body`"}},"tags":["brig"]}},"/search-users":{"post":{"description":" [<a href=\"https://docs.wire.com/developer/developer/servant.html#named-and-internal-route-ids\">internal route ID:</a> \"search-users\"]\n\nAll federated endpoints expect origin domain header: `Wire-Origin-Domain`","operationId":"search-users","requestBody":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/SearchRequest"}}},"required":true},"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/SearchResponse"}}},"description":""},"400":{"description":"Invalid `body`"}},"tags":["brig"]}},"/send-connection-action":{"post":{"description":" [<a href=\"https://docs.wire.com/developer/developer/servant.html#named-and-internal-route-ids\">internal route ID:</a> \"send-connection-action\"]\n\nAll federated endpoints expect origin domain header: `Wire-Origin-Domain`","operationId":"send-connection-action","requestBody":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/NewConnectionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json;charset=utf-8":{"schema":{"$ref":"#/components/schemas/NewConnectionResponse"}}},"description":""},"400":{"description":"Invalid `body`"}},"tags":["brig"]}}}}