package vault.v1
Get desktop application:
View/edit binary Protocol Buffers messages
service Entity
vault.proto:273Service for managing entities.
rpc CreateEntity (, )
vault.proto:275Creates an entity.
message
vault.proto:6Request message for creating an entity.
string country_code = 1
The ISO 3166-1 alpha-2 country code of the entity.
string phone_number = 2
The phone number of the entity.
string password = 3
The password of the entity.
string client_publish_pub_key = 4
The client's public key for publishing.
string client_device_id_pub_key = 5
The client's public key for device identification.
string ownership_proof_response = 6
The ownership proof response from the client.
message
vault.proto:22Response message for creating an entity.
bool requires_ownership_proof = 1
Indicates if ownership proof is required.
string long_lived_token = 2
A long-lived token for the authenticated entity.
string server_publish_pub_key = 3
The server's public key for publishing.
string server_device_id_pub_key = 4
The server's public key for device identification.
string message = 5
A response message.
int32 next_attempt_timestamp = 6
The next available time to request another proof of ownership.
rpc AuthenticateEntity (, )
vault.proto:277Authenticates an entity.
message
vault.proto:38Request message for authenticating an entity.
string phone_number = 1
The phone number of the entity.
string password = 2
The password of the entity.
string client_publish_pub_key = 3
The client's public key for publishing.
string client_device_id_pub_key = 4
The client's public key for device identification.
string ownership_proof_response = 5
The ownership proof response from the client.
message
vault.proto:52Response message for authenticating an entity.
bool requires_ownership_proof = 1
Indicates if ownership proof is required.
string long_lived_token = 2
A long-lived token for the authenticated entity.
string server_publish_pub_key = 3
The server's public key for publishing.
string server_device_id_pub_key = 4
The server's public key for device identification.
string message = 5
A response message.
int32 next_attempt_timestamp = 6
The next available time to request another proof of ownership.
Lists all stored access tokens for an entity.
message
vault.proto:68Request message for listing entity's stored tokens.
string long_lived_token = 1
The long-lived token of the authenticated entity.
message
vault.proto:74Response message for listing entity's stored tokens.
repeated stored_tokens = 1
The list of stored tokens.
string message = 2
A response message.
rpc DeleteEntity (, )
vault.proto:281Deletes an entity.
message
vault.proto:211Request message for deleting an entity.
string long_lived_token = 1
The long-lived token of the authenticated entity.
message
vault.proto:217Response message for deleting an entity.
string message = 1
A response message.
bool success = 2
Indicates whether the operation was successful.
rpc ResetPassword (, )
vault.proto:283Resets an entity's password
message
vault.proto:225Request message for resetting an entity's password.
string phone_number = 1
The phone number of the entity.
string new_password = 2
The new password of the entity.
string client_publish_pub_key = 3
The client's public key for publishing.
string client_device_id_pub_key = 4
The client's public key for device identification.
string ownership_proof_response = 5
The ownership proof response from the client.
message
vault.proto:239Response message for resetting an entity's password.
bool requires_ownership_proof = 1
Indicates if ownership proof is required.
string long_lived_token = 2
A long-lived token for the authenticated entity.
string server_publish_pub_key = 3
The server's public key for publishing.
string server_device_id_pub_key = 4
The server's public key for device identification.
string message = 5
A response message.
int32 next_attempt_timestamp = 6
The next available time to request another proof of ownership.
rpc UpdateEntityPassword (, )
vault.proto:285Updates an entity's password.
message
vault.proto:255Request message for updating an entity's password.
string long_lived_token = 1
The long-lived token of the authenticated entity.
string current_password = 2
The current password of the entity.
string new_password = 3
The new password of the entity.
message
vault.proto:265Response message for updating an entity's password.
string message = 1
A response message.
bool success = 2
Indicates whether the operation was successful.
service EntityInternal
vault.proto:289Service for managing entities internally.
rpc StoreEntityToken (, )
vault.proto:291Stores a token for an entity.
message
vault.proto:90Request message for storing an entity's token.
string long_lived_token = 1
The long-lived token of the authenticated entity.
string token = 2
The OAuth2 token to be stored (JSON string).
string platform = 3
The platform associated with the token.
string account_identifier = 4
The identifier of the account associated with the token.
message
vault.proto:102Response message for storing an entity's token.
string message = 1
A response message.
bool success = 2
Indicates whether the operation was successful.
rpc GetEntityAccessToken (, )
vault.proto:293Get an entity's access token.
message
vault.proto:110Request message for getting entity access token.
string device_id = 1
Device ID for identifying the requesting device.
string long_lived_token = 2
The long-lived token of the authenticated entity.
string platform = 3
The platform associated with the token.
string account_identifier = 4
The identifier of the account associated with the token.
string phone_number = 5
The phone number of the entity.
message
vault.proto:124Response message for getting entity access token.
string token = 1
Entity access token (JSON string).
string message = 2
A response message.
bool success = 3
Indicates whether the operation was successful.
rpc DecryptPayload (, )
vault.proto:295Decrypt payload.
message
vault.proto:134Request message for decrypting payload.
string device_id = 1
Device ID for identifying the requesting device.
string payload_ciphertext = 2
Encrypted payload that needs to be decrypted.
string phone_number = 3
The phone number of the entity.
message
vault.proto:143string payload_plaintext = 1
Decrypted plaintext payload.
string message = 2
A response message.
bool success = 3
Indicates whether the operation was successful.
rpc EncryptPayload (, )
vault.proto:297Encrypt payload.
message
vault.proto:153Request message for encrypting payload.
string device_id = 1
Device ID for identifying the requesting device.
string payload_plaintext = 2
Plaintext payload to be encrypted.
message
vault.proto:161Response message for encrypting payload.
string payload_ciphertext = 1
Encrypted payload.
string message = 2
A response message.
bool success = 3
Indicates whether the operation was successful.
rpc UpdateEntityToken (, )
vault.proto:299Updates an entity's access token.
message
vault.proto:171Request message for updating an entity's token.
string device_id = 1
Device ID for identifying the requesting device.
string token = 2
The OAuth2 token to be stored (JSON string).
string platform = 3
The platform associated with the token.
string account_identifier = 4
The identifier of the account associated with the token.
string phone_number = 5
The phone number of the entity.
message
vault.proto:185Response message for updating an entity's token.
string message = 1
A response message.
bool success = 2
Indicates whether the operation was successful.
rpc DeleteEntityToken (, )
vault.proto:301Deletes an entity's access token.
message
vault.proto:193Request message for deleting an entity's token.
string long_lived_token = 1
The long-lived token of the authenticated entity.
string platform = 2
The platform associated with the token.
string account_identifier = 3
The identifier of the account associated with the token.
message
vault.proto:203Response message for deleting an entity's token.
string message = 1
A response message.
bool success = 2
Indicates whether the operation was successful.
message
vault.proto:82Represents a token.
Used in:
string platform = 1
The platform associated with the token.
string account_identifier = 2
The unique identifier of the account associated with the token.