From afd2564ea435bea70d342ff30e4cfa62612a1985 Mon Sep 17 00:00:00 2001 From: Documentation Updater Date: Fri, 10 Jul 2026 18:30:33 +0000 Subject: [PATCH] Updating documentation --- grpc/org.signal.chat.account.html | 811 ++++++++++++++++++++++++++++++ grpc/search.html | 4 +- signal-server-openapi.yaml | 2 +- 3 files changed, 814 insertions(+), 3 deletions(-) diff --git a/grpc/org.signal.chat.account.html b/grpc/org.signal.chat.account.html index 200a005d0..99fd84421 100644 --- a/grpc/org.signal.chat.account.html +++ b/grpc/org.signal.chat.account.html @@ -105,6 +105,24 @@ +

+ + Message + ChangeNumberRequest + +

+ + + +

+ + Message + ChangeNumberResponse + +

+ + +

Message @@ -240,6 +258,37 @@ + + + + +

+ + Message + ExternalServiceCredentials + +

+ + + +

+ + Message + GetAccountDataReportRequest + +

+ + + +

+ + Message + GetAccountDataReportResponse + +

+ + +

Message @@ -312,6 +361,17 @@ + + +

+ + Message + RegistrationLockFailure + +

+ + +

Message @@ -420,6 +480,15 @@ +

+ + Message + StaleDevices + +

+ + +

Message @@ -746,6 +815,46 @@ via the Contact Discovery Service (CDS).

Store a public key used to issue and verify zero-knowledge (anonymous) credentials for the account.

+ + +
+
+
+ + rpc ChangeNumber + +
+ Request: org.signal.chat.account.ChangeNumberRequest +
+ Response: org.signal.chat.account.ChangeNumberResponse +
+
+ + +
+

Changes the phone number associated with the authenticated account.

+
+ +
+ +
+
+
+ + rpc GetAccountDataReport + +
+ Request: org.signal.chat.account.GetAccountDataReportRequest +
+ Response: org.signal.chat.account.GetAccountDataReportResponse +
+
+ + +
+

Produces a report of non-ephemeral account data stored by the service

+
+
@@ -992,6 +1101,416 @@ ProductConfiguration.GetConfiguration.

+
+ + +

+ + message ChangeNumberRequest + + + +

+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
3 + number + + + + string + +

The new phone number for the authenticated account.

4 + registration_lock + + + + bytes + +

The registration lock secret for the new phone number, if the account +associated with the new phone number has a registration lock configured.

5 + pni_identity_key + + + + bytes + +

The new public identity key to use for the phone-number identity (PNI) +associated with the new phone number.

6 + device_messages + + + + org.signal.chat.messages.IndividualRecipientMessageBundle + + +

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.

7 + device_pni_signed_pre_keys + + + + map<uint32, EcSignedPreKey> + +

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.

8 + device_pni_pq_last_resort_pre_keys + + + + map<uint32, KemSignedPreKey> + +

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.

9 + pni_registration_ids + + + + map<uint32, uint32> + +

The new phone-number-identity registration ID for each device on the +account, including the sending device, keyed by device ID.

+
+ oneof verification +
+
+ 1 + + session_id + + + + bytes + +

A verified registration session ID (as returned by the registration +service) for the new phone number.

+ 2 + + recovery_password + + + + bytes + +

A registration recovery password for the new phone number.

+ +
+ + + +
+ + +

+ + message ChangeNumberResponse + + + +

+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
+
+ oneof response +
+
+ 1 + + account_identifiers + + + + org.signal.chat.common.AccountIdentifiers + + +

The identifiers of the account after the successful +number change.

+ 2 + + mismatched_devices + + + + org.signal.chat.messages.MismatchedDevices + + +

Mismatched number of devices or device ids in 'devices to notify' list

+ 3 + + registration_lock_failure + + + + org.signal.chat.account.RegistrationLockFailure + + +

The account associated with the new phone number has a registration lock, +and the provided registration lock secret was missing or incorrect.

+ 4 + + stale_devices + + + + org.signal.chat.account.StaleDevices + + +

Mismatched registration ids in 'devices to notify' list

+ 5 + + message_too_large + + + + org.signal.chat.errors.FailedPrecondition + + +

One or more device messages was too large

+ 6 + + unverified_registration_session + + + + org.signal.chat.errors.FailedPrecondition + + +

The registration session is unverified

+ 7 + + invalid_registration_session + + + + org.signal.chat.errors.FailedPrecondition + + +

The number does not match the registration session, or the registration session is invalid

+ 8 + + recovery_password_verification_failed + + + + org.signal.chat.errors.FailedPrecondition + + +
+ +
+ + +
@@ -1736,6 +2255,175 @@ another caller.

+ + + + +
+ + +

+ + message ExternalServiceCredentials + + + +

+ +
+

A username/password pair for authenticating with an external service.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
1 + username + + + + string + +

A username that can be presented to authenticate with the external service.

2 + password + + + + string + +

A password that can be presented to authenticate with the external service.

+ +
+ + + +
+ + +

+ + message GetAccountDataReportRequest + + + +

+ +
+ +
+ + + + + + + + + + + + + + + +
FieldTypeDescription
+ +
+ + + +
+ + +

+ + message GetAccountDataReportResponse + + + +

+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
3 + json + + + + string + +

The JSON representation of the data report

4 + text + + + + string + +

A plaintext representation of the data report

+ +
+ + +
@@ -2198,6 +2886,75 @@ another caller.

+ + +
+ + +

+ + message RegistrationLockFailure + + + +

+ +
+

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.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
1 + time_remaining_millis + + + + uint64 + +

Time remaining in milliseconds before the existing registration lock expires

2 + svr2_credentials + + + + org.signal.chat.account.ExternalServiceCredentials + + +

Credentials that can be used with SVR2

+ +
+ + +
@@ -2847,6 +3604,60 @@ as reverting to the previous key will result in a new rotation ID.

+
+ + +

+ + message StaleDevices + + + +

+ +
+

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).

+
+ + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
1 + stale_devices + + + + repeated + + uint32 + +

The IDs of devices that are no longer active.

+ +
+ + +
diff --git a/grpc/search.html b/grpc/search.html index 0575cb41b..ad0196aab 100644 --- a/grpc/search.html +++ b/grpc/search.html @@ -60,8 +60,8 @@