package api.v1.user.settings

Get desktop application:
View/edit binary Protocol Buffers messages

The Settings service provides methods for getting and updating the users settings.

• rpc GetSettings (GetSettingsRequest, GetSettingsResponse)

  service.proto:11

  Gets the users settings for the current project.

  message GetSettingsRequest

  service.proto:17

  Request for getting users settings for the Rig project.

  (message has no fields)

  message GetSettingsResponse

  service.proto:20

  Response for getting users settings for the Rig project.

  • optional Settings settings = 1

    The users settings.

• rpc UpdateSettings (UpdateSettingsRequest, UpdateSettingsResponse)

  service.proto:13

  Sets the users settings for the current project.

  message UpdateSettingsRequest

  service.proto:26

  Request for updating users settings for the Rig project.

  • repeated Update settings = 1

    The updates to apply to the users settings.

  message UpdateSettingsResponse

  service.proto:32

  Empty response for updating users settings for the Rig project.

  (message has no fields)

Message that tells how the user was authenticated.

• oneof method

  • model.LoginType login_type = 1

Default email provider instance.

Used in: EmailInstance, TextInstance

(message has no fields)

Type of email instance in a provider.

Used in: EmailProvider, EmailProviderEntry

• oneof instance

  • DefaultInstance default = 1

    default from platform config.

  • MailjetInstance mailjet = 2

    Mailjet instance.

  • SmtpInstance smtp = 3

    SMTP instance.

The email provider.

Used in: Update

• string from = 1

  The email-address that the provider sends emails from.

• optional model.ProviderCredentials credentials = 2

  The credentials for the provider.

• optional EmailInstance instance = 3

  The instance of the provider.

an entry model for the email provider.

Used in: Settings

• string from = 1

  The email-address that the provider sends emails from.

• string client_id = 2

  The client id for the provider.

• string secret_id = 3

  The secret id for the provider.

• optional EmailInstance instance = 4

  The instance of the provider.

Mailjet email rpvoider instance.

Used in: EmailInstance

(message has no fields)

Message that tells how the user was registered / created.

• oneof method

  The method used to register a user.

  • RegisterMethod.System system = 1

    The user was created by the system.

  • RegisterMethod.Signup signup = 2

    The user was self-registered with a login-type.

The user was self-registered with a login-type.

Used in: RegisterMethod

• model.LoginType login_type = 1

  The login type used to register.

The user was created by the system.

Used in: RegisterMethod

(message has no fields)

The users settings configuration. Settings of everything that has to do with users.

Used in: GetSettingsResponse

• bool allow_register = 1

  If true, users can self register.

• bool is_verified_email_required = 2

  If true, users must be verified via email to login.

• bool is_verified_phone_required = 3

  Deprecated: Text is not supported - If true, users must be verified via phone to login.

• optional google.protobuf.Duration access_token_ttl = 4

  Access token Time to Live.

• optional google.protobuf.Duration refresh_token_ttl = 5

  Refresh token Time to Live.

• optional google.protobuf.Duration verification_code_ttl = 6

  Verification code Time to Live.

• optional model.HashingConfig password_hashing = 7

  The hashing config used to hash passwords.

• repeated model.LoginType login_mechanisms = 8

  The allowed login mechanisms.

• bool send_welcome_mail = 10

  If true, send a welcome email to new users.

• optional EmailProviderEntry email_provider = 11

  The email provider.

• optional TextProviderEntry text_provider = 12

  Deprecated: Text is not supported - The text provider.

• optional Templates templates = 13

  The templates used for sending emails and texts.

SMTP email provider instance.

Used in: EmailInstance

• string host = 1

  Host of the smtp server.

• int64 port = 2

  Port of the smtp server.

A generic template model for sending emails and texts.

Used in: Templates, Update

• string body = 1

  The body of the template.

• string subject = 2

  The subject of the template.

• TemplateType type = 3

  The type of the template.

• repeated string format = 4

  The format of the template.

The different template types.

Used in: Template

• TEMPLATE_TYPE_UNSPECIFIED = 0

  Unspecified template type.

• TEMPLATE_TYPE_WELCOME_EMAIL = 1

  The welcome email template.

• TEMPLATE_TYPE_EMAIL_VERIFICATION = 2

  The email verification template.

• TEMPLATE_TYPE_EMAIL_RESET_PASSWORD = 3

  The reset password email template.

• TEMPLATE_TYPE_WELCOME_TEXT = 4

  Deprecated: Text is not supported - The welcome text template.

• TEMPLATE_TYPE_TEXT_VERIFICATION = 5

  Deprecated: Text is not supported - The text verification template.

• TEMPLATE_TYPE_TEXT_RESET_PASSWORD = 6

  Deprecated: Text is not supported - The reset password text template.

Used in: Settings

• optional Template welcome_email = 1

  The welcome email template.

• optional Template welcome_text = 2

  Deprecated: Text is not supported - The welcome text template.

• optional Template reset_password_email = 3

  The reset password email template.

• optional Template reset_password_text = 4

  Deprecated: Text is not supported - The reset password text template.

• optional Template verify_email = 5

  The email verification template.

• optional Template verify_phone_number = 6

  Deprecated: Text is not supported - The text verification template.

Deprecated: Text is not supported - Type of text instance in a provider.

Used in: TextProvider, TextProviderEntry

• oneof instance

  • DefaultInstance default = 1

    default from platform config.

  • TwilioInstance twilio = 2

    Twilio instance.

Deprecated: Text is not supported - The text provider.

Used in: Update

• string from = 1

  The phone number that the provider sends texts from.

• optional model.ProviderCredentials credentials = 2

  The credentials for the provider.

• optional TextInstance instance = 3

  The instance of the provider.

Deprecated: Text is not supported - An entry model for the text provider.

Used in: Settings

• string from = 1

  The phone number that the provider sends texts from.

• string client_id = 2

  The client id for the provider.

• string secret_id = 3

  The secret id for the provider.

• optional TextInstance instance = 4

  The instance of the provider.

Deprecated: Text is not supported - Default text provider instance.

Used in: TextInstance

(message has no fields)

Update message for updating users settings.

Used in: UpdateSettingsRequest

• oneof field

  A oneof field for the different settings fields.

  • bool allow_register = 1

    If true, users can self register.

  • bool is_verified_email_required = 2

    If true, users must be verified via email to login.

  • bool is_verified_phone_required = 3

    If true, users must be verified via phone to login.

  • google.protobuf.Duration access_token_ttl = 4

    Access token Time to Live.

  • google.protobuf.Duration refresh_token_ttl = 5

    Refresh token Time to Live.

  • google.protobuf.Duration verification_code_ttl = 6

    Verification code Time to Live.

  • model.HashingConfig password_hashing = 7

    The hashing config used to hash passwords.

  • Update.LoginMechanisms login_mechanisms = 8

    The allowed login mechanisms.

  • EmailProvider email_provider = 9

    The email provider.

  • TextProvider text_provider = 10

    The text provider.

  • Template template = 11

    The templates used for sending emails and texts.

The allowed login mechanisms

Used in: Update

• repeated model.LoginType login_mechanisms = 1