olp-cpp-sdk  1.22.0
Public Attributes | List of all members
olp::authentication::AuthenticationClient::SignUpProperties Struct Reference

Used to create a new HERE account for the specified user with the email and password that are your login credentials. More...

#include <AuthenticationClient.h>

Public Attributes

std::string email
 (Required) Your valid email address.
 
std::string password
 (Required) Your plain-text password.
 
std::string date_of_birth
 (Required) Your date of birth in the following format: dd/mm/yyyy.
 
std::string first_name
 (Required) Your first name.
 
std::string last_name
 (Required) Your last name.
 
std::string country_code
 (Required) The code of the country in which you live in the ISO 3166-1 alpha-3 format.
 
std::string language
 (Required) The code of the language that you speak in the ISO 639-1 alpha-2 format.
 
bool marketing_enabled {false}
 (Optional) Indicates if the user has opted in to marketing.
 
std::string phone_number
 (Optional) Your valid phone number. More...
 
std::string realm
 (Optional) The realm in which you want to create the user. More...
 
std::string invite_token
 (Optional) The valid Authorization Invite Token with a payload that matches the user email and requested realm. Required for the invite-only realms.
 

Detailed Description

Used to create a new HERE account for the specified user with the email and password that are your login credentials.

Member Data Documentation

◆ phone_number

std::string olp::authentication::AuthenticationClient::SignUpProperties::phone_number

(Optional) Your valid phone number.

It must start with the plus (+) sign and consist of 7 to 17 numbers.

◆ realm

std::string olp::authentication::AuthenticationClient::SignUpProperties::realm

(Optional) The realm in which you want to create the user.

The HERE Account realms partition the account data into namespaces. In other words, if you sign up for an account in realm A, you cannot use the same credentials to sign in to realm B. The default realm value is HERE.


The documentation for this struct was generated from the following file: