From f648ed8311b2bd9b40e8c3c2d2fdf757067e64bb Mon Sep 17 00:00:00 2001 From: Documentation Updater Date: Thu, 20 Aug 2026 22:18:56 +0000 Subject: [PATCH] Updating documentation --- grpc/org.signal.chat.account.html | 1153 +++++++++++++++++++++++++++++ grpc/org.signal.chat.profile.html | 162 +++- grpc/search.html | 4 +- signal-server-openapi.yaml | 15 +- 4 files changed, 1328 insertions(+), 6 deletions(-) diff --git a/grpc/org.signal.chat.account.html b/grpc/org.signal.chat.account.html index d29498097..828d45ed0 100644 --- a/grpc/org.signal.chat.account.html +++ b/grpc/org.signal.chat.account.html @@ -186,6 +186,24 @@ +

+ + Message + ConfirmTotpKeyRequest + +

+ + + +

+ + Message + ConfirmTotpKeyResponse + +

+ + +

Message @@ -280,6 +298,24 @@ +

+ + Message + GenerateTotpKeyRequest + +

+ + + +

+ + Message + GenerateTotpKeyResponse + +

+ + +

Message @@ -370,6 +406,44 @@ +

+ + Message + KeyConfirmed + +

+ + + +

+ + Message + KeyGenerated + +

+ + + + + +

+ + Message + ListTotpKeysRequest + +

+ + + +

+ + Message + ListTotpKeysResponse + +

+ + +

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

+ + Message + MetadataUpdated + +

+ + +

@@ -417,6 +500,24 @@ +

+ + Message + RemoveTotpKeyRequest + +

+ + + +

+ + Message + RemoveTotpKeyResponse + +

+ + +

Message @@ -489,6 +590,24 @@ +

+ + Message + SetTotpKeyMetadataRequest + +

+ + + +

+ + Message + SetTotpKeyMetadataResponse + +

+ + +

Message @@ -534,6 +653,24 @@ +

+ + Message + TotpKeyMetadata + +

+ + + +

+ + Message + TotpParameters + +

+ + +

Message @@ -920,6 +1057,110 @@ via the Contact Discovery Service (CDS).

Gets the capabilities for the authenticated account.

+ + +
+
+
+ + rpc GenerateTotpKey + +
+ Request: org.signal.chat.account.GenerateTotpKeyRequest +
+ Response: org.signal.chat.account.GenerateTotpKeyResponse +
+
+ + +
+

Generates and stores a pending TOTP key for the authenticated account. +To "activate" the key, callers must call the ConfirmTotpKey endpoint.

+
+ +
+ +
+
+
+ + rpc ConfirmTotpKey + +
+ Request: org.signal.chat.account.ConfirmTotpKeyRequest +
+ Response: org.signal.chat.account.ConfirmTotpKeyResponse +
+
+ + +
+

Confirms that the caller has stored and can derive one-time passwords from +a pending TOTP key generated via GenerateTotpKey and stores/activates the +key for the caller's account

+
+ +
+ +
+
+
+ + rpc ListTotpKeys + +
+ Request: org.signal.chat.account.ListTotpKeysRequest +
+ Response: org.signal.chat.account.ListTotpKeysResponse +
+
+ + +
+

Returns a list of confirmed TOTP keys for the authenticated account

+
+ +
+ +
+
+
+ + rpc SetTotpKeyMetadata + +
+ Request: org.signal.chat.account.SetTotpKeyMetadataRequest +
+ Response: org.signal.chat.account.SetTotpKeyMetadataResponse +
+
+ + +
+

Updates encrypted, user-supplied metadata (e.g. a human-readable name and +creation timestamp) for an existing, confirmed TOTP key

+
+ +
+ +
+
+
+ + rpc RemoveTotpKey + +
+ Request: org.signal.chat.account.RemoveTotpKeyRequest +
+ Response: org.signal.chat.account.RemoveTotpKeyResponse +
+
+ + +
+

Removes a TOTP from the authenticated account

+
+
@@ -1948,6 +2189,161 @@ unidentified_access_key

+
+ + +

+ + message ConfirmTotpKeyRequest + + + +

+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
1 + one_time_password + + + + uint32 + +

A one-time password derived from the current pending TOTP key

2 + metadata_ciphertext + + + + bytes + +

The ciphertext of user-provided metadata (presumably including a +human-readable name and creation timestamp) to be attached to the +newly-confirmed key

+ +
+ + + +
+ + +

+ + message ConfirmTotpKeyResponse + + + +

+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
+
+ oneof response +
+
+ 1 + + key_confirmed + + + + org.signal.chat.account.ConfirmTotpKeyResponse.KeyConfirmed + + +

The provided one-time password was accepted and the pending TOTP key was +stored with the provided name ciphertext

+ 2 + + one_time_password_not_verified + + + + org.signal.chat.errors.FailedPrecondition + + +

The provided one-time password was not valid for any reason (including +incorrect passwords, misaligned clocks, or missing account records)

+ +
+ + +
@@ -2469,6 +2865,129 @@ another caller.

+
+ + +

+ + message GenerateTotpKeyRequest + + + +

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

+ + message GenerateTotpKeyResponse + + + +

+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
+
+ oneof response +
+
+ 1 + + key_generated + + + + org.signal.chat.account.GenerateTotpKeyResponse.KeyGenerated + + +

A new, pending TOTP key has been generated and added to the authenticated +account

+ 2 + + too_many_totp_keys + + + + org.signal.chat.errors.FailedPrecondition + + +

The authenticated account already has too many TOTP keys, and the caller +must remove one before adding more

+ +
+ + +
@@ -3051,6 +3570,215 @@ another caller.

+
+ + +

+ + message KeyConfirmed + +
(Nested in org.signal.chat.account.ConfirmTotpKeyResponse + ) + + + +

+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
1 + key_id + + + + uint32 + +

The account-specific identifier for the newly-confirmed TOTP key

+ +
+ + + +
+ + +

+ + message KeyGenerated + +
(Nested in org.signal.chat.account.GenerateTotpKeyResponse + ) + + + +

+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
1 + key + + + + bytes + +

The raw TOTP key

2 + totp_parameters + + + + org.signal.chat.account.TotpParameters + + +

The TOTP parameters associated with the generated key

+ +
+ + + + + +
+ + +

+ + message ListTotpKeysRequest + + + +

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

+ + message ListTotpKeysResponse + + + +

+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
1 + keys + + + + map<int32, TotpKeyMetadata> + +
+ +
+ + +
@@ -3323,6 +4051,44 @@ another caller.

+
+ + +

+ + message MetadataUpdated + +
(Nested in org.signal.chat.account.SetTotpKeyMetadataResponse + ) + + + +

+ +
+ +
+ + + + + + + + + + + + + + + +
FieldTypeDescription
+ +
+ + +
@@ -3392,6 +4158,91 @@ be used to recover the secret used to derive the registration lock password.

+
+ + +

+ + message RemoveTotpKeyRequest + + + +

+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
1 + key_id + + + + uint32 + +

The account-specific identifier of the TOTP key to remove

+ +
+ + + +
+ + +

+ + message RemoveTotpKeyResponse + + + +

+ +
+ +
+ + + + + + + + + + + + + + + +
FieldTypeDescription
+ +
+ + +
@@ -3787,6 +4638,158 @@ this account by other means (i.e. by username).

+
+ + +

+ + message SetTotpKeyMetadataRequest + + + +

+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
1 + key_id + + + + uint32 + +

The account-specific identifier of the TOTP key to modify

2 + metadata_ciphertext + + + + bytes + +

The ciphertext of the new user-provided metadata to be attached to the +identified key

+ +
+ + + +
+ + +

+ + message SetTotpKeyMetadataResponse + + + +

+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
+
+ oneof response +
+
+ 1 + + metadata_updated + + + + org.signal.chat.account.SetTotpKeyMetadataResponse.MetadataUpdated + + +

New metadata was stored for the identified TOTP key

+ 2 + + key_not_found + + + + org.signal.chat.errors.NotFound + + +

No TOTP was found with the given ID

+ +
+ + +
@@ -4095,6 +5098,156 @@ device).

+
+ + +

+ + message TotpKeyMetadata + +
(Nested in org.signal.chat.account.ListTotpKeysResponse + ) + + + +

+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
1 + metadata_ciphertext + + + + bytes + +

The user-provided ciphertext for metadata associated with this TOTP key

2 + totp_parameters + + + + org.signal.chat.account.TotpParameters + + +

The TOTP parameters associated with this key

+ +
+ + + +
+ + +

+ + message TotpParameters + + + +

+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
1 + algorithm + + + + string + +

The HMAC algorithm (e.g. "HmacSHA256") used by the TOTP generator

2 + password_length + + + + uint32 + +

The length of one-time passwords (in decimal digits) produced and expected +by the TOTP generator

3 + time_step_seconds + + + + uint32 + +

The time step (in seconds) used by the TOTP generator

+ +
+ + +
diff --git a/grpc/org.signal.chat.profile.html b/grpc/org.signal.chat.profile.html index 5e25363ea..8ef2396d7 100644 --- a/grpc/org.signal.chat.profile.html +++ b/grpc/org.signal.chat.profile.html @@ -311,6 +311,24 @@

+ +

+ + Message + SetV1AvatarRequest + +

+ + + +

+ + Message + SetV1AvatarResponse + +

+ +

@@ -414,6 +432,32 @@ should use the version of this method in ProfileAnonymous instead.<

Note: Accounts.SetZkCredentialKey is a pre-requisite for this RPC

+
+ +
+
+
+ + rpc SetV1Avatar + +
+ Request: org.signal.chat.profile.SetV1AvatarRequest +
+ Response: org.signal.chat.profile.SetV1AvatarResponse +
+
+ + +
+

Returns credentials used by clients to upload a v1 avatar, deleting any current avatar.

+

This RPC streamlines avatar changes during the v1 -> v2 transition by minimizing uploads: +1. SetV1Avatar +2. Upload to CDN +3. SetProfile with v1 AVATAR_CHANGE_UNCHANGED and the v1 avatar in the v2 profile body

+

Clients that do this will be required to upload current avatars using ProfilesAnonymous.GetAvatarUploadFormRequest +once v1 Profile APIs are no longer supported.

+
+
@@ -1200,7 +1244,7 @@ performed with this form will be limited to the provided length.

- +

the policy and credential used by clients to upload an avatar to the CDN

@@ -2821,6 +2865,122 @@ field number without serialization overhead. This is purely aesthetic.

+ +
+ + +

+ + message SetV1AvatarRequest + + + +

+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
1 + version + + + + string + +

The profile version. Required.

2 + commitment + + + + bytes + +

The profile key commitment. Required if this is a new profile version.

+ +
+ + + +
+ + +

+ + message SetV1AvatarResponse + + + +

+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
FieldTypeDescription
1 + form + + + + org.signal.chat.common.S3UploadForm + + +

the policy and credential used by clients to upload an avatar to the CDN

+ +
+ + diff --git a/grpc/search.html b/grpc/search.html index 7198595d4..a2646a23d 100644 --- a/grpc/search.html +++ b/grpc/search.html @@ -60,8 +60,8 @@