Signal/Signal-Server
1
0 Fork 0
mirror of https://github.com/signalapp/Signal-Server synced 2026-10-09 05:29:26 +01:00
Code Issues Packages Projects Releases Wiki Activity

Updating documentation

Browse Source
This commit is contained in:
Documentation Updater committed 2026-07-10 18:30:33 +00:00
1 parent 20d09491c9
commit afd2564ea4
3 files changed
+814 -3
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

grpc/org.signal.chat.account.html
+811
View File
@@ -105,6 +105,24 @@
<p>
<a href="#message-org.signal.chat.account.ChangeNumberRequest">
<span class="tag" style="min-width: 6em">Message</span>
<code>ChangeNumberRequest</code>
</a>
</p>
<p>
<a href="#message-org.signal.chat.account.ChangeNumberResponse">
<span class="tag" style="min-width: 6em">Message</span>
<code>ChangeNumberResponse</code>
</a>
</p>
<p>
<a href="#message-org.signal.chat.account.CheckAccountExistenceRequest">
<span class="tag" style="min-width: 6em">Message</span>
@@ -240,6 +258,37 @@
<p>
<a href="#message-org.signal.chat.account.ExternalServiceCredentials">
<span class="tag" style="min-width: 6em">Message</span>
<code>ExternalServiceCredentials</code>
</a>
</p>
<p>
<a href="#message-org.signal.chat.account.GetAccountDataReportRequest">
<span class="tag" style="min-width: 6em">Message</span>
<code>GetAccountDataReportRequest</code>
</a>
</p>
<p>
<a href="#message-org.signal.chat.account.GetAccountDataReportResponse">
<span class="tag" style="min-width: 6em">Message</span>
<code>GetAccountDataReportResponse</code>
</a>
</p>
<p>
<a href="#message-org.signal.chat.account.GetAccountIdentityRequest">
<span class="tag" style="min-width: 6em">Message</span>
@@ -312,6 +361,17 @@
<p>
<a href="#message-org.signal.chat.account.RegistrationLockFailure">
<span class="tag" style="min-width: 6em">Message</span>
<code>RegistrationLockFailure</code>
</a>
</p>
<p>
<a href="#message-org.signal.chat.account.ReserveUsernameHashRequest">
<span class="tag" style="min-width: 6em">Message</span>
@@ -420,6 +480,15 @@
<p>
<a href="#message-org.signal.chat.account.StaleDevices">
<span class="tag" style="min-width: 6em">Message</span>
<code>StaleDevices</code>
</a>
</p>
<p>
<a href="#message-org.signal.chat.account.UsernameNotAvailable">
<span class="tag" style="min-width: 6em">Message</span>
@@ -746,6 +815,46 @@ via the Contact Discovery Service (CDS).</p></p>
<p><p>Store a public key used to issue and verify zero-knowledge (anonymous) credentials for the account.</p></p>
</div>
</div>
<div class="box">
<div class="block">
<h5 class="title is-5" id="service-org.signal.chat.account.Accounts-ChangeNumber">
<a href="#service-org.signal.chat.account.Accounts-ChangeNumber">
rpc <code>ChangeNumber</code>
</a>
</h5>
Request: <code><a href="org.signal.chat.account.html#message-org.signal.chat.account.ChangeNumberRequest"><span title="org.signal.chat.account.ChangeNumberRequest">org.signal.chat.account.ChangeNumberRequest</span>
</a></code><br>
Response: <code><a href="org.signal.chat.account.html#message-org.signal.chat.account.ChangeNumberResponse"><span title="org.signal.chat.account.ChangeNumberResponse">org.signal.chat.account.ChangeNumberResponse</span>
</a></code><br>
</div>
<div class="block">
<p><p>Changes the phone number associated with the authenticated account.</p></p>
</div>
</div>
<div class="box">
<div class="block">
<h5 class="title is-5" id="service-org.signal.chat.account.Accounts-GetAccountDataReport">
<a href="#service-org.signal.chat.account.Accounts-GetAccountDataReport">
rpc <code>GetAccountDataReport</code>
</a>
</h5>
Request: <code><a href="org.signal.chat.account.html#message-org.signal.chat.account.GetAccountDataReportRequest"><span title="org.signal.chat.account.GetAccountDataReportRequest">org.signal.chat.account.GetAccountDataReportRequest</span>
</a></code><br>
Response: <code><a href="org.signal.chat.account.html#message-org.signal.chat.account.GetAccountDataReportResponse"><span title="org.signal.chat.account.GetAccountDataReportResponse">org.signal.chat.account.GetAccountDataReportResponse</span>
</a></code><br>
</div>
<div class="block">
<p><p>Produces a report of non-ephemeral account data stored by the service</p></p>
</div>
</div>
</div>
@@ -992,6 +1101,416 @@ ProductConfiguration.GetConfiguration.</p></td>
<div class="block">
<h4 class="title is-4 type-heading" id="message-org.signal.chat.account.ChangeNumberRequest">
<span>
<a href="#message-org.signal.chat.account.ChangeNumberRequest" title="org.signal.chat.account.ChangeNumberRequest">message ChangeNumberRequest</a>
</span>
</h4>
<div class="block content">
</div>
<table class="table is-fullwidth is-hoverable is-bordered">
<thead>
<tr>
<th></th>
<th>Field</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>3</td>
<td>
number
</td>
<td>
<code title="string">
<span>string</span>
</code>
</td>
<td class="content"><p>The new phone number for the authenticated account.</p></td>
</tr>
<tr>
<td>4</td>
<td>
registration_lock
</td>
<td>
<code title="bytes">
<span>bytes</span>
</code>
</td>
<td class="content"><p>The registration lock secret for the new phone number, if the account
associated with the new phone number has a registration lock configured.</p></td>
</tr>
<tr>
<td>5</td>
<td>
pni_identity_key
</td>
<td>
<code title="bytes">
<span>bytes</span>
</code>
</td>
<td class="content"><p>The new public identity key to use for the phone-number identity (PNI)
associated with the new phone number.</p></td>
</tr>
<tr>
<td>6</td>
<td>
device_messages
</td>
<td>
<code title="org.signal.chat.messages.IndividualRecipientMessageBundle">
<a href="org.signal.chat.messages.html#message-org.signal.chat.messages.IndividualRecipientMessageBundle"><span title="org.signal.chat.messages.IndividualRecipientMessageBundle">org.signal.chat.messages.IndividualRecipientMessageBundle</span>
</a>
</code>
</td>
<td class="content"><p>Synchronization messages to send to companion devices to supply the private
keys associated with the new identity key and their new pre-keys. Exactly
one message must be supplied for each device other than the sending
(primary) device. May be omitted if no companion devices are linked to the
account.</p></td>
</tr>
<tr>
<td>7</td>
<td>
device_pni_signed_pre_keys
</td>
<td>
<code title="map&lt;uint32, EcSignedPreKey&gt;">
<span>map&lt;uint32, EcSignedPreKey&gt;</span>
</code>
</td>
<td class="content"><p>A new signed EC pre-key for each device on the account, including the
sending device, keyed by device ID. Each must be accompanied by a valid
signature from the identity key in this request.</p></td>
</tr>
<tr>
<td>8</td>
<td>
device_pni_pq_last_resort_pre_keys
</td>
<td>
<code title="map&lt;uint32, KemSignedPreKey&gt;">
<span>map&lt;uint32, KemSignedPreKey&gt;</span>
</code>
</td>
<td class="content"><p>A new signed post-quantum last-resort pre-key for each device on the
account, including the sending device, keyed by device ID. Each must be
accompanied by a valid signature from the identity key in this request.</p></td>
</tr>
<tr>
<td>9</td>
<td>
pni_registration_ids
</td>
<td>
<code title="map&lt;uint32, uint32&gt;">
<span>map&lt;uint32, uint32&gt;</span>
</code>
</td>
<td class="content"><p>The new phone-number-identity registration ID for each device on the
account, including the sending device, keyed by device ID.</p></td>
</tr>
<tr class="nohover"><td style="border: 0px"></td></tr>
<tr class="nohover">
<td class="oneof-heading" colspan="4">
<div class="oneof-heading">
<strong>oneof verification</strong>
</div>
</td>
</tr>
<tr>
<td>
1
</td>
<td>
session_id
</td>
<td>
<code title="bytes">
<span>bytes</span>
</code>
</td>
<td class="content"><p>A verified registration session ID (as returned by the registration
service) for the new phone number.</p></td>
</tr>
<tr>
<td>
2
</td>
<td>
recovery_password
</td>
<td>
<code title="bytes">
<span>bytes</span>
</code>
</td>
<td class="content"><p>A registration recovery password for the new phone number.</p></td>
</tr>
</tbody>
</table>
</div>
<div class="block">
<h4 class="title is-4 type-heading" id="message-org.signal.chat.account.ChangeNumberResponse">
<span>
<a href="#message-org.signal.chat.account.ChangeNumberResponse" title="org.signal.chat.account.ChangeNumberResponse">message ChangeNumberResponse</a>
</span>
</h4>
<div class="block content">
</div>
<table class="table is-fullwidth is-hoverable is-bordered">
<thead>
<tr>
<th></th>
<th>Field</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr class="nohover"><td style="border: 0px"></td></tr>
<tr class="nohover">
<td class="oneof-heading" colspan="4">
<div class="oneof-heading">
<strong>oneof response</strong>
</div>
</td>
</tr>
<tr>
<td>
1
</td>
<td>
account_identifiers
</td>
<td>
<code title="org.signal.chat.common.AccountIdentifiers">
<a href="org.signal.chat.common.html#message-org.signal.chat.common.AccountIdentifiers"><span title="org.signal.chat.common.AccountIdentifiers">org.signal.chat.common.AccountIdentifiers</span>
</a>
</code>
</td>
<td class="content"><p>The identifiers of the account after the successful
number change.</p></td>
</tr>
<tr>
<td>
2
</td>
<td>
mismatched_devices
</td>
<td>
<code title="org.signal.chat.messages.MismatchedDevices">
<a href="org.signal.chat.messages.html#message-org.signal.chat.messages.MismatchedDevices"><span title="org.signal.chat.messages.MismatchedDevices">org.signal.chat.messages.MismatchedDevices</span>
</a>
</code>
</td>
<td class="content"><p>Mismatched number of devices or device ids in 'devices to notify' list</p></td>
</tr>
<tr>
<td>
3
</td>
<td>
registration_lock_failure
</td>
<td>
<code title="org.signal.chat.account.RegistrationLockFailure">
<a href="org.signal.chat.account.html#message-org.signal.chat.account.RegistrationLockFailure"><span title="org.signal.chat.account.RegistrationLockFailure">org.signal.chat.account.RegistrationLockFailure</span>
</a>
</code>
</td>
<td class="content"><p>The account associated with the new phone number has a registration lock,
and the provided registration lock secret was missing or incorrect.</p></td>
</tr>
<tr>
<td>
4
</td>
<td>
stale_devices
</td>
<td>
<code title="org.signal.chat.account.StaleDevices">
<a href="org.signal.chat.account.html#message-org.signal.chat.account.StaleDevices"><span title="org.signal.chat.account.StaleDevices">org.signal.chat.account.StaleDevices</span>
</a>
</code>
</td>
<td class="content"><p>Mismatched registration ids in 'devices to notify' list</p></td>
</tr>
<tr>
<td>
5
</td>
<td>
message_too_large
</td>
<td>
<code title="org.signal.chat.errors.FailedPrecondition">
<a href="org.signal.chat.errors.html#message-org.signal.chat.errors.FailedPrecondition"><span title="org.signal.chat.errors.FailedPrecondition">org.signal.chat.errors.FailedPrecondition</span>
</a>
</code>
</td>
<td class="content"><p>One or more device messages was too large</p></td>
</tr>
<tr>
<td>
6
</td>
<td>
unverified_registration_session
</td>
<td>
<code title="org.signal.chat.errors.FailedPrecondition">
<a href="org.signal.chat.errors.html#message-org.signal.chat.errors.FailedPrecondition"><span title="org.signal.chat.errors.FailedPrecondition">org.signal.chat.errors.FailedPrecondition</span>
</a>
</code>
</td>
<td class="content"><p>The registration session is unverified</p></td>
</tr>
<tr>
<td>
7
</td>
<td>
invalid_registration_session
</td>
<td>
<code title="org.signal.chat.errors.FailedPrecondition">
<a href="org.signal.chat.errors.html#message-org.signal.chat.errors.FailedPrecondition"><span title="org.signal.chat.errors.FailedPrecondition">org.signal.chat.errors.FailedPrecondition</span>
</a>
</code>
</td>
<td class="content"><p>The number does not match the registration session, or the registration session is invalid</p></td>
</tr>
<tr>
<td>
8
</td>
<td>
recovery_password_verification_failed
</td>
<td>
<code title="org.signal.chat.errors.FailedPrecondition">
<a href="org.signal.chat.errors.html#message-org.signal.chat.errors.FailedPrecondition"><span title="org.signal.chat.errors.FailedPrecondition">org.signal.chat.errors.FailedPrecondition</span>
</a>
</code>
</td>
<td class="content"></td>
</tr>
</tbody>
</table>
</div>
<div class="block">
@@ -1736,6 +2255,175 @@ another caller.</p></td>
<div class="block">
<h4 class="title is-4 type-heading" id="message-org.signal.chat.account.ExternalServiceCredentials">
<span>
<a href="#message-org.signal.chat.account.ExternalServiceCredentials" title="org.signal.chat.account.ExternalServiceCredentials">message ExternalServiceCredentials</a>
</span>
</h4>
<div class="block content">
<p>A username/password pair for authenticating with an external service.</p>
</div>
<table class="table is-fullwidth is-hoverable is-bordered">
<thead>
<tr>
<th></th>
<th>Field</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>1</td>
<td>
username
</td>
<td>
<code title="string">
<span>string</span>
</code>
</td>
<td class="content"><p>A username that can be presented to authenticate with the external service.</p></td>
</tr>
<tr>
<td>2</td>
<td>
password
</td>
<td>
<code title="string">
<span>string</span>
</code>
</td>
<td class="content"><p>A password that can be presented to authenticate with the external service.</p></td>
</tr>
</tbody>
</table>
</div>
<div class="block">
<h4 class="title is-4 type-heading" id="message-org.signal.chat.account.GetAccountDataReportRequest">
<span>
<a href="#message-org.signal.chat.account.GetAccountDataReportRequest" title="org.signal.chat.account.GetAccountDataReportRequest">message GetAccountDataReportRequest</a>
</span>
</h4>
<div class="block content">
</div>
<table class="table is-fullwidth is-hoverable is-bordered">
<thead>
<tr>
<th></th>
<th>Field</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
</tbody>
</table>
</div>
<div class="block">
<h4 class="title is-4 type-heading" id="message-org.signal.chat.account.GetAccountDataReportResponse">
<span>
<a href="#message-org.signal.chat.account.GetAccountDataReportResponse" title="org.signal.chat.account.GetAccountDataReportResponse">message GetAccountDataReportResponse</a>
</span>
</h4>
<div class="block content">
</div>
<table class="table is-fullwidth is-hoverable is-bordered">
<thead>
<tr>
<th></th>
<th>Field</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>3</td>
<td>
json
</td>
<td>
<code title="string">
<span>string</span>
</code>
</td>
<td class="content"><p>The JSON representation of the data report</p></td>
</tr>
<tr>
<td>4</td>
<td>
text
</td>
<td>
<code title="string">
<span>string</span>
</code>
</td>
<td class="content"><p>A plaintext representation of the data report</p></td>
</tr>
</tbody>
</table>
</div>
<div class="block">
@@ -2198,6 +2886,75 @@ another caller.</p></td>
<div class="block">
<h4 class="title is-4 type-heading" id="message-org.signal.chat.account.RegistrationLockFailure">
<span>
<a href="#message-org.signal.chat.account.RegistrationLockFailure" title="org.signal.chat.account.RegistrationLockFailure">message RegistrationLockFailure</a>
</span>
</h4>
<div class="block content">
<p>Information about the current Registration lock and SVR credentials. With a correct PIN, the credentials can
be used to recover the secret used to derive the registration lock password.</p>
</div>
<table class="table is-fullwidth is-hoverable is-bordered">
<thead>
<tr>
<th></th>
<th>Field</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>1</td>
<td>
time_remaining_millis
</td>
<td>
<code title="uint64">
<span>uint64</span>
</code>
</td>
<td class="content"><p>Time remaining in milliseconds before the existing registration lock expires</p></td>
</tr>
<tr>
<td>2</td>
<td>
svr2_credentials
</td>
<td>
<code title="org.signal.chat.account.ExternalServiceCredentials">
<a href="org.signal.chat.account.html#message-org.signal.chat.account.ExternalServiceCredentials"><span title="org.signal.chat.account.ExternalServiceCredentials">org.signal.chat.account.ExternalServiceCredentials</span>
</a>
</code>
</td>
<td class="content"><p>Credentials that can be used with SVR2</p></td>
</tr>
</tbody>
</table>
</div>
<div class="block">
@@ -2847,6 +3604,60 @@ as reverting to the previous key will result in a new rotation ID.</p></td>
<div class="block">
<h4 class="title is-4 type-heading" id="message-org.signal.chat.account.StaleDevices">
<span>
<a href="#message-org.signal.chat.account.StaleDevices" title="org.signal.chat.account.StaleDevices">message StaleDevices</a>
</span>
</h4>
<div class="block content">
<p>A list of devices that are linked to the account but presented a stale
registration ID (indicating the device has likely been replaced by another
device).</p>
</div>
<table class="table is-fullwidth is-hoverable is-bordered">
<thead>
<tr>
<th></th>
<th>Field</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>1</td>
<td>
stale_devices
</td>
<td>
<code title="uint32">
repeated
<span>uint32</span>
</code>
</td>
<td class="content"><p>The IDs of devices that are no longer active.</p></td>
</tr>
</tbody>
</table>
</div>
<div class="block">
grpc/search.html
+2 -2
View File
@@ -60,8 +60,8 @@
<div id="main-content" class="container mb-6">
<script>
const searchDocuments = {"org.signal.chat.account": {"package": "org.signal.chat.account", "url": "org.signal.chat.account.html", "content": "org.signal.chat.account\n\norg\nsignal\nchat\naccount\nAccounts\nProvides methods for working with Signal accounts.\nGetAccountIdentity\nReturns basic identifiers for the authenticated account.\norg\nsignal\nchat\naccount\nGetAccountIdentityRequest\norg\nsignal\nchat\naccount\nGetAccountIdentityResponse\nGetEntitlements\nReturns entitlements for the authenticated account.\norg\nsignal\nchat\naccount\nGetEntitlementsRequest\norg\nsignal\nchat\naccount\nGetEntitlementsResponse\nDeleteAccount\nDeletes the authenticated account, purging all associated data in the\n process.\norg\nsignal\nchat\naccount\nDeleteAccountRequest\norg\nsignal\nchat\naccount\nDeleteAccountResponse\nSetRegistrationLock\nSets the registration lock secret for the authenticated account. To remove\n a registration lock, please use `ClearRegistrationLock`.\norg\nsignal\nchat\naccount\nSetRegistrationLockRequest\norg\nsignal\nchat\naccount\nSetRegistrationLockResponse\nClearRegistrationLock\nRemoves any registration lock credentials from the authenticated account.\norg\nsignal\nchat\naccount\nClearRegistrationLockRequest\norg\nsignal\nchat\naccount\nClearRegistrationLockResponse\nReserveUsernameHash\nAttempts to reserve one of multiple given username hashes. Reserved\n usernames may be claimed later via `ConfirmUsernameHash`.\norg\nsignal\nchat\naccount\nReserveUsernameHashRequest\norg\nsignal\nchat\naccount\nReserveUsernameHashResponse\nConfirmUsernameHash\nSets the username hash/encrypted username to a previously-reserved value\n (see `ReserveUsernameHash`).\norg\nsignal\nchat\naccount\nConfirmUsernameHashRequest\norg\nsignal\nchat\naccount\nConfirmUsernameHashResponse\nDeleteUsernameHash\nClears the current username hash, ciphertext, and link for the\n authenticated user.\norg\nsignal\nchat\naccount\nDeleteUsernameHashRequest\norg\nsignal\nchat\naccount\nDeleteUsernameHashResponse\nSetUsernameLink\nAssociates the given username ciphertext with the account, replacing any\n previously stored ciphertext. A new link handle will optionally be created,\n and the link handle to use will be returned in any event.\norg\nsignal\nchat\naccount\nSetUsernameLinkRequest\norg\nsignal\nchat\naccount\nSetUsernameLinkResponse\nDeleteUsernameLink\nClears any username link associated with the authenticated account.\norg\nsignal\nchat\naccount\nDeleteUsernameLinkRequest\norg\nsignal\nchat\naccount\nDeleteUsernameLinkResponse\nConfigureUnidentifiedAccess\nConfigures \"unidentified access\" keys and preferences for the authenticated\n account. Other users permitted to interact with this account anonymously\n may take actions like fetching pre-keys and profiles for this account or\n sending sealed-sender messages without providing identifying credentials.\norg\nsignal\nchat\naccount\nConfigureUnidentifiedAccessRequest\norg\nsignal\nchat\naccount\nConfigureUnidentifiedAccessResponse\nSetDiscoverableByPhoneNumber\nSets whether the authenticated account may be discovered by phone number\n via the Contact Discovery Service (CDS).\norg\nsignal\nchat\naccount\nSetDiscoverableByPhoneNumberRequest\norg\nsignal\nchat\naccount\nSetDiscoverableByPhoneNumberResponse\nSetRegistrationRecoveryPassword\nSets the registration recovery password for the authenticated account.\norg\nsignal\nchat\naccount\nSetRegistrationRecoveryPasswordRequest\norg\nsignal\nchat\naccount\nSetRegistrationRecoveryPasswordResponse\nSetZkCredentialKey\nStore a public key used to issue and verify zero-knowledge (anonymous) credentials for the account.\norg\nsignal\nchat\naccount\nSetZkCredentialKeyRequest\norg\nsignal\nchat\naccount\nSetZkCredentialKeyResponse\norg\nsignal\nchat\naccount\nAccountsAnonymous\nProvides methods for looking up Signal accounts. Callers must not provide\n identifying credentials when calling methods in this service.\nCheckAccountExistence\nChecks whether an account with the given service identifier exists.\norg\nsignal\nchat\naccount\nCheckAccountExistenceRequest\norg\nsignal\nchat\naccount\nCheckAccountExistenceResponse\nLookupUsernameHash\nFinds the service identifier of the account associated with the given\n username hash.\norg\nsignal\nchat\naccount\nLookupUsernameHashRequest\norg\nsignal\nchat\naccount\nLookupUsernameHashResponse\nLookupUsernameLink\nFinds the encrypted username identified by a given username link handle.\norg\nsignal\nchat\naccount\nLookupUsernameLinkRequest\norg\nsignal\nchat\naccount\nLookupUsernameLinkResponse\norg\nsignal\nchat\naccount\nGetEntitlementsResponse\nBackupEntitlement\nlevel\nThe backup level of the account\nexpiration_epoch_seconds\nWhen the backup entitlement expires, in number of seconds since epoch\norg\nsignal\nchat\naccount\nGetEntitlementsResponse\nBadgeEntitlement\nbadge_id\nThe id of the badge the account is entitled. Metadata to display for\n badges may be obtained by cross-referenciLine truncated
const searchIndex = {"version": "2.3.9", "fields": ["content", "url"], "fieldVectors": [["content/org.signal.chat.account", [0, 1.945, 1, 0.176, 2, 0.177, 3, 0.176, 4, 1.5, 5, 0.392, 6, 0.804, 7, 0.822, 8, 1.945, 9, 0.939, 10, 1.945, 11, 1.512, 12, 1.365, 13, 2.886, 14, 2.886, 15, 1.945, 16, 2.748, 17, 2.886, 18, 3.805, 19, 1.945, 20, 1.104, 21, 1.945, 22, 0.949, 23, 1.104, 24, 1.296, 25, 2.886, 26, 2.886, 27, 1.945, 28, 1.057, 29, 2.415, 30, 3.04, 31, 1.923, 32, 1.637, 33, 1.945, 34, 0.433, 35, 2.886, 36, 2.886, 37, 2.886, 38, 1.11, 39, 2.886, 40, 2.886, 41, 2.886, 42, 2.305, 43, 4.407, 44, 0.712, 45, 1.296, 46, 2.258, 47, 2.577, 48, 2.406, 49, 3.44, 50, 1.554, 51, 1.488, 52, 2.886, 53, 2.886, 54, 2.886, 55, 1.945, 56, 1.409, 57, 0.939, 58, 1.296, 59, 2.886, 60, 3.44, 61, 1.945, 62, 2.305, 63, 1.409, 64, 2.937, 65, 2.098, 66, 1.799, 67, 2.886, 68, 2.886, 69, 1.945, 70, 1.296, 71, 1.68, 72, 1.236, 73, 3.22, 74, 0.822, 75, 1.409, 76, 1.945, 77, 2.886, 78, 2.886, 79, 1.945, 80, 2.886, 81, 2.886, 82, 1.945, 83, 1.637, 84, 2.306, 85, 1.488, 86, 1.262, 87, 1.554, 88, 1.637, 89, 3.04, 90, 1.717, 91, 1.945, 92, 1.554, 93, 1.554, 94, 0.95, 95, 1.923, 96, 1.219, 97, 1.104, 98, 1.104, 99, 0.914, 100, 1.409, 101, 2.886, 102, 2.886, 103, 1.945, 104, 1.453, 105, 3.44, 106, 1.637, 107, 1.206, 108, 2.886, 109, 2.886, 110, 1.434, 111, 2.886, 112, 2.886, 113, 2.886, 114, 1.945, 115, 2.305, 116, 1.637, 117, 2.886, 118, 2.886, 119, 1.945, 120, 1.637, 121, 0.822, 122, 1.104, 123, 2.748, 124, 2.305, 125, 2.886, 126, 2.886, 127, 1.945, 128, 1.554, 129, 0.95, 130, 1.259, 131, 0.531, 132, 1.945, 133, 1.104, 134, 1.858, 135, 2.886, 136, 2.886, 137, 1.945, 138, 3.805, 139, 2.886, 140, 2.886, 141, 1.945, 142, 1.453, 143, 2.886, 144, 2.886, 145, 1.945, 146, 2.292, 147, 2.535, 148, 2.886, 149, 1.219, 150, 1.056, 151, 0.914, 152, 1.945, 153, 1.554, 154, 0.68, 155, 2.152, 156, 1.296, 157, 1.296, 158, 1.296, 159, 1.945, 160, 1.554, 161, 1.945, 162, 2.305, 163, 1.637, 164, 1.945, 165, 1.858, 166, 1.554, 167, 1.09, 168, 1.104, 169, 1.637, 170, 0.616, 171, 1.554, 172, 1.923, 173, 0.674, 174, 1.637, 175, 1.945, 176, 2.748, 177, 3.247, 178, 1.945, 179, 1.554, 180, 0.889, 181, 1.554, 182, 3.44, 183, 1.945, 184, 1.945, 185, 1.554, 186, 1.554, 187, 1.945, 188, 1.554, 189, 1.945, 190, 1.104, 191, 0.95, 192, 2.748, 193, 1.945, 194, 2.886, 195, 1.945, 196, 0.571, 197, 0.95, 198, 1.945, 199, 2.305, 200, 2.748, 201, 0.788, 202, 1.554, 203, 0.822, 204, 1.945, 205, 1.554, 206, 1.945, 207, 1.554, 208, 1.219, 209, 2.305, 210, 1.945, 211, 1.945, 212, 1.554, 213, 1.945, 214, 0.531, 215, 0.95, 216, 1.637, 217, 1.296, 218, 0.454, 219, 1.945, 220, 1.945, 221, 1.104, 222, 1.945, 223, 1.296, 224, 1.945, 225, 1.945, 226, 1.945, 227, 1.104, 228, 1.296, 229, 1.945, 230, 1.296, 231, 0.712, 232, 1.104, 233, 1.945, 234, 1.945, 235, 1.945, 236, 1.104, 237, 0.531, 238, 1.554, 239, 1.923, 240, 1.945, 241, 0.712, 242, 1.945, 243, 1.296, 244, 1.945, 245, 1.945]], ["url/org.signal.chat.account", [246, 2.539]], ["content/org.signal.chat.attachments", [1, 0.171, 2, 0.171, 3, 0.171, 5, 0.298, 34, 0.509, 72, 1.013, 107, 1.176, 154, 0.734, 170, 1.413, 180, 0.867, 196, 0.882, 247, 3.712, 248, 3.03, 249, 2.965, 250, 2.617, 251, 2.923, 252, 2.972, 253, 2.473, 254, 3.563, 255, 3.563, 256, 3.712, 257, 5.21, 258, 5.074, 259, 4.46, 260, 4.46, 261, 3.712, 262, 3.712, 263, 3.712, 264, 3.712, 265, 1.013, 266, 3.712, 267, 3.712, 268, 2.965, 269, 2.106, 270, 2.965, 271, 2.972, 272, 1.812, 273, 2.965, 274, 2.965, 275, 2.712, 276, 2.965, 277, 2.53, 278, 2.106, 279, 2.965, 280, 2.106, 281, 2.965, 282, 2.965]], ["url/org.signal.chat.attachments", [283, 2.539]], ["content/org.signal.chat.backup", [1, 0.174, 2, 0.174, 3, 0.174, 4, 1.216, 5, 0.389, 9, 1.063, 12, 1.314, 20, 1.97, 22, 1.022, 23, 1.573, 28, 1.085, 31, 0.92, 32, 1.257, 34, 0.5, 38, 1.415, 44, 0.811, 47, 1.082, 51, 1.271, 56, 1.809, 57, 0.866, 63, 1.354, 65, 0.936, 71, 2.396, 72, 0.377, 85, 0.506, 86, 1.409, 89, 1.103, 90, 1.34, 93, 1.103, 99, 1.386, 107, 0.438, 110, 1.1, 116, 1.257, 120, 2.768, 121, 0.584, 122, 2.429, 129, 1.082, 131, 0.605, 134, 1.082, 142, 1.709, 146, 2.469, 147, 3.658, 149, 1.566, 150, 1.015, 151, 0.702, 154, 1.006, 156, 0.92, 160, 1.103, 167, 1.174, 170, 1.386, 171, 1.103, 173, 1.218, 176, 1.103, 180, 0.648, 190, 1.573, 191, 1.809, 196, 0.959, 203, 1.171, 207, 1.769, 208, 1.34, 214, 0.866, 215, 1.082, 216, 0.784, 217, 1.847, 218, 0.517, 221, 0.784, 227, 0.784, 228, 0.92, 230, 0.92, 231, 0.811, 232, 0.784, 236, 1.8, 237, 0.866, 241, 0.506, 243, 0.92, 248, 2.368, 249, 1.103, 250, 2.267, 251, 1.97, 252, 2.594, 253, 1.847, 254, 2.534, 255, 1.769, 265, 0.866, 270, 1.103, 271, 2.469, 272, 1.354, 273, 1.103, 274, 1.103, 275, 1.573, 276, 1.103, 277, 1.573, 278, 1.573, 279, 1.103, 280, 1.257, 281, 1.103, 282, 1.103, 284, 1.381, 285, 2.368, 286, 1.695, 287, 0.784, 288, 2.534, 289, 1.381, 290, 3.232, 291, 1.381, 292, 1.847, 293, 0.784, 294, 1.271, 295, 1.103, 296, 3.472, 297, 3.472, 298, 2.114, 299, 1.103, 300, 1.381, 3Line truncated
const searchDocuments = {"org.signal.chat.account": {"package": "org.signal.chat.account", "url": "org.signal.chat.account.html", "content": "org.signal.chat.account\n\norg\nsignal\nchat\naccount\nAccounts\nProvides methods for working with Signal accounts.\nGetAccountIdentity\nReturns basic identifiers for the authenticated account.\norg\nsignal\nchat\naccount\nGetAccountIdentityRequest\norg\nsignal\nchat\naccount\nGetAccountIdentityResponse\nGetEntitlements\nReturns entitlements for the authenticated account.\norg\nsignal\nchat\naccount\nGetEntitlementsRequest\norg\nsignal\nchat\naccount\nGetEntitlementsResponse\nDeleteAccount\nDeletes the authenticated account, purging all associated data in the\n process.\norg\nsignal\nchat\naccount\nDeleteAccountRequest\norg\nsignal\nchat\naccount\nDeleteAccountResponse\nSetRegistrationLock\nSets the registration lock secret for the authenticated account. To remove\n a registration lock, please use `ClearRegistrationLock`.\norg\nsignal\nchat\naccount\nSetRegistrationLockRequest\norg\nsignal\nchat\naccount\nSetRegistrationLockResponse\nClearRegistrationLock\nRemoves any registration lock credentials from the authenticated account.\norg\nsignal\nchat\naccount\nClearRegistrationLockRequest\norg\nsignal\nchat\naccount\nClearRegistrationLockResponse\nReserveUsernameHash\nAttempts to reserve one of multiple given username hashes. Reserved\n usernames may be claimed later via `ConfirmUsernameHash`.\norg\nsignal\nchat\naccount\nReserveUsernameHashRequest\norg\nsignal\nchat\naccount\nReserveUsernameHashResponse\nConfirmUsernameHash\nSets the username hash/encrypted username to a previously-reserved value\n (see `ReserveUsernameHash`).\norg\nsignal\nchat\naccount\nConfirmUsernameHashRequest\norg\nsignal\nchat\naccount\nConfirmUsernameHashResponse\nDeleteUsernameHash\nClears the current username hash, ciphertext, and link for the\n authenticated user.\norg\nsignal\nchat\naccount\nDeleteUsernameHashRequest\norg\nsignal\nchat\naccount\nDeleteUsernameHashResponse\nSetUsernameLink\nAssociates the given username ciphertext with the account, replacing any\n previously stored ciphertext. A new link handle will optionally be created,\n and the link handle to use will be returned in any event.\norg\nsignal\nchat\naccount\nSetUsernameLinkRequest\norg\nsignal\nchat\naccount\nSetUsernameLinkResponse\nDeleteUsernameLink\nClears any username link associated with the authenticated account.\norg\nsignal\nchat\naccount\nDeleteUsernameLinkRequest\norg\nsignal\nchat\naccount\nDeleteUsernameLinkResponse\nConfigureUnidentifiedAccess\nConfigures \"unidentified access\" keys and preferences for the authenticated\n account. Other users permitted to interact with this account anonymously\n may take actions like fetching pre-keys and profiles for this account or\n sending sealed-sender messages without providing identifying credentials.\norg\nsignal\nchat\naccount\nConfigureUnidentifiedAccessRequest\norg\nsignal\nchat\naccount\nConfigureUnidentifiedAccessResponse\nSetDiscoverableByPhoneNumber\nSets whether the authenticated account may be discovered by phone number\n via the Contact Discovery Service (CDS).\norg\nsignal\nchat\naccount\nSetDiscoverableByPhoneNumberRequest\norg\nsignal\nchat\naccount\nSetDiscoverableByPhoneNumberResponse\nSetRegistrationRecoveryPassword\nSets the registration recovery password for the authenticated account.\norg\nsignal\nchat\naccount\nSetRegistrationRecoveryPasswordRequest\norg\nsignal\nchat\naccount\nSetRegistrationRecoveryPasswordResponse\nSetZkCredentialKey\nStore a public key used to issue and verify zero-knowledge (anonymous) credentials for the account.\norg\nsignal\nchat\naccount\nSetZkCredentialKeyRequest\norg\nsignal\nchat\naccount\nSetZkCredentialKeyResponse\nChangeNumber\nChanges the phone number associated with the authenticated account.\norg\nsignal\nchat\naccount\nChangeNumberRequest\norg\nsignal\nchat\naccount\nChangeNumberResponse\nGetAccountDataReport\nProduces a report of non-ephemeral account data stored by the service\norg\nsignal\nchat\naccount\nGetAccountDataReportRequest\norg\nsignal\nchat\naccount\nGetAccountDataReportResponse\norg\nsignal\nchat\naccount\nAccountsAnonymous\nProvides methods for looking up Signal accounts. Callers must not provide\n identifying credentials when calling methods in this service.\nCheckAccountExistence\nChecks whether an account with the given service identifier exists.\norg\nsignal\nchat\naccount\nCheckAccountExistenceRequest\norg\nsignal\nchat\naccount\nCheckAccountExistenceResponse\nLookupUsernameHash\nFinds the service identifier of the account associated with the given\n username hash.\norg\nsignal\nchat\naccount\nLookupUsernameHashRequest\norg\nsignal\nchat\naccount\nLookupUsernameHashResponse\nLookupUsernameLink\nFinds the encrypted username identified by a given username link handle.\norg\nsignal\nchat\naccount\nLookupUsernameLinkRequest\norg\nsignal\nchat\naccount\nLookupUsernameLinkResponse\norg\nsignal\Line truncated
const searchIndex = {"version": "2.3.9", "fields": ["content", "url"], "fieldVectors": [["content/org.signal.chat.account", [0, 1.657, 1, 0.176, 2, 0.176, 3, 0.176, 4, 1.499, 5, 0.383, 6, 0.729, 7, 0.7, 8, 1.657, 9, 0.957, 10, 1.657, 11, 1.478, 12, 1.363, 13, 2.556, 14, 2.556, 15, 1.657, 16, 2.492, 17, 2.556, 18, 3.507, 19, 1.657, 20, 0.94, 21, 1.657, 22, 1.055, 23, 1.989, 24, 1.104, 25, 2.556, 26, 2.556, 27, 1.657, 28, 1.006, 29, 2.817, 30, 3.531, 31, 2.337, 32, 1.45, 33, 1.657, 34, 0.444, 35, 2.556, 36, 2.556, 37, 2.556, 38, 1.093, 39, 2.556, 40, 2.556, 41, 2.556, 42, 2.041, 43, 4.172, 44, 1.142, 45, 1.104, 46, 2.159, 47, 2.55, 48, 2.332, 49, 3.12, 50, 1.323, 51, 1.387, 52, 2.556, 53, 2.556, 54, 2.556, 55, 1.657, 56, 1.248, 57, 1.093, 58, 1.104, 59, 2.556, 60, 3.12, 61, 1.657, 62, 2.041, 63, 1.248, 64, 2.78, 65, 2.055, 66, 1.691, 67, 2.556, 68, 2.556, 69, 1.657, 70, 1.104, 71, 1.712, 72, 1.37, 73, 3.108, 74, 0.7, 75, 1.248, 76, 1.657, 77, 2.556, 78, 2.556, 79, 1.657, 80, 2.556, 81, 2.556, 82, 1.657, 83, 1.77, 84, 2.149, 85, 1.387, 86, 1.382, 87, 1.323, 88, 1.45, 89, 2.801, 90, 1.601, 91, 1.657, 92, 1.323, 93, 1.323, 94, 1.712, 95, 1.703, 96, 1.763, 97, 0.94, 98, 0.94, 99, 1.2, 100, 1.248, 101, 2.556, 102, 2.556, 103, 1.657, 104, 1.318, 105, 3.12, 106, 2.646, 107, 1.564, 108, 2.556, 109, 2.556, 110, 1.478, 111, 2.556, 112, 2.556, 113, 2.556, 114, 1.657, 115, 2.492, 116, 2.149, 117, 2.556, 118, 2.556, 119, 1.657, 120, 1.77, 121, 0.7, 122, 1.45, 123, 2.492, 124, 2.041, 125, 2.556, 126, 2.556, 127, 1.657, 128, 1.248, 129, 3.789, 130, 2.556, 131, 1.657, 132, 1.323, 133, 3.12, 134, 1.45, 135, 1.323, 136, 2.556, 137, 2.556, 138, 1.657, 139, 1.323, 140, 0.809, 141, 1.142, 142, 0.452, 143, 1.657, 144, 0.94, 145, 1.85, 146, 2.556, 147, 2.556, 148, 1.657, 149, 3.507, 150, 2.556, 151, 2.556, 152, 1.657, 153, 1.318, 154, 2.556, 155, 2.556, 156, 1.657, 157, 2.079, 158, 2.337, 159, 2.556, 160, 1.318, 161, 0.936, 162, 0.81, 163, 1.657, 164, 1.323, 165, 0.909, 166, 2.037, 167, 1.104, 168, 1.104, 169, 1.104, 170, 1.657, 171, 1.323, 172, 1.657, 173, 2.041, 174, 1.657, 175, 2.337, 176, 1.657, 177, 2.556, 178, 1.657, 179, 1.528, 180, 0.94, 181, 1.657, 182, 1.323, 183, 2.556, 184, 2.098, 185, 2.041, 186, 1.104, 187, 1.657, 188, 2.271, 189, 0.94, 190, 1.104, 191, 1.657, 192, 1.703, 193, 1.104, 194, 0.957, 195, 2.556, 196, 1.248, 197, 1.45, 198, 0.693, 199, 1.657, 200, 1.323, 201, 1.657, 202, 0.94, 203, 1.323, 204, 1.657, 205, 2.041, 206, 0.452, 207, 1.323, 208, 2.041, 209, 2.556, 210, 0.852, 211, 1.657, 212, 1.657, 213, 1.323, 214, 2.041, 215, 1.657, 216, 0.94, 217, 1.657, 218, 1.657, 219, 1.657, 220, 1.657, 221, 0.809, 222, 0.607, 223, 1.657, 224, 1.45, 225, 1.657, 226, 1.712, 227, 1.323, 228, 0.988, 229, 0.94, 230, 1.45, 231, 0.525, 232, 1.323, 233, 1.703, 234, 0.819, 235, 1.45, 236, 1.657, 237, 2.492, 238, 3.027, 239, 1.657, 240, 1.323, 241, 0.819, 242, 1.323, 243, 3.12, 244, 1.657, 245, 1.657, 246, 1.323, 247, 1.323, 248, 1.657, 249, 1.323, 250, 1.657, 251, 0.94, 252, 0.809, 253, 2.492, 254, 1.657, 255, 2.556, 256, 1.657, 257, 0.809, 258, 1.657, 259, 2.041, 260, 2.492, 261, 0.698, 262, 1.657, 263, 1.657, 264, 1.657, 265, 2.041, 266, 2.041, 267, 3.12, 268, 1.657, 269, 1.104, 270, 1.08, 271, 1.657, 272, 1.323, 273, 1.657, 274, 1.323, 275, 1.08, 276, 2.041, 277, 1.657, 278, 1.323, 279, 1.657, 280, 1.657, 281, 1.657, 282, 0.387, 283, 1.104, 284, 0.94, 285, 0.809, 286, 1.657, 287, 1.657, 288, 1.657, 289, 0.809, 290, 1.45, 291, 1.104, 292, 0.387, 293, 1.657, 294, 1.657, 295, 0.94, 296, 1.657, 297, 1.104, 298, 1.657, 299, 1.657, 300, 0.94, 301, 1.104, 302, 1.657, 303, 1.104, 304, 0.607, 305, 0.94, 306, 1.657, 307, 1.657, 308, 1.657, 309, 1.323, 310, 1.703, 311, 1.657, 312, 1.657, 313, 1.104, 314, 1.657, 315, 1.657, 316, 0.94, 317, 1.657]], ["url/org.signal.chat.account", [318, 2.539]], ["content/org.signal.chat.attachments", [1, 0.171, 2, 0.171, 3, 0.171, 5, 0.299, 34, 0.51, 72, 1.018, 107, 1.182, 128, 1.821, 165, 0.738, 198, 0.884, 231, 1.417, 241, 0.871, 319, 3.729, 320, 3.032, 321, 2.979, 322, 2.619, 323, 2.926, 324, 2.98, 325, 2.485, 326, 3.573, 327, 3.573, 328, 3.729, 329, 5.215, 330, 5.08, 331, 4.473, 332, 4.473, 333, 3.729, 334, 3.729, 335, 3.729, 336, 3.729, 337, 1.018, 338, 3.729, 339, 3.729, 340, 2.979, 341, 2.116, 342, 2.979, 343, 2.98, 344, 1.821, 345, 2.979, 346, 2.979, 347, 2.718, 348, 2.979, 349, 2.537, 350, 2.116, 351, 2.979, 352, 2.979, 353, 2.979]], ["url/org.signal.chat.attachments", [354, 2.539]], ["content/org.signal.chat.backup", [1, 0.174, 2, 0.174, 3, 0.174, 4, 1.224, 5, 0.39, 9, 1.073, 12, 1.32, 20, 1.993, 22, 1.029, 23, 1.598, 28, 1.09, 31, 0.942, 32, 1.28, 34, 0.502, 38, 1.418, 44, 0.826, 47, 1.102, 51, 1.286, 56, 1.828, 57, 0.878, 63, 1.375, 65, 0.954, 71, 2.405, 72, 0.386, 85, 0.518, 86, 1.412, 89, 1.13, 90, 1.358, 93, 1.13, 99, 1.395, 107, 0.448, 110, 1.113, 116, 1.28, 120, 2.779, 121, 0.597, 122, 2.447, 128, 1.102, 134, 1.824, 140, 1.102, 142, 0.616, 145, 1.102, 153, 1.724, 157, 2.495, 158, 3.66Line truncated
const idx = lunr.Index.load(searchIndex);
signal-server-openapi.yaml
+1 -1
View File
@@ -6588,7 +6588,7 @@ components:
properties:
id:
type: string
description: A URL-safe ID for the session
description: A URL-safe base64-encoded ID for the session
nextSms:
type: integer
description: Duration in seconds after which next SMS can be requested for