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

The federated (Facebook, Google, ArcGIS) sign-in properties structure. More...

#include <AuthenticationClient.h>

Public Attributes

std::string access_token
 (Required) A valid Facebook, Google, or ArcGIS access token obtained from the Facebook, Google, or ArcGIS token endpoint.
 
std::string country_code
 The code of the country in which you live in the ISO 3166-1 alpha-3 format. More...
 
std::string language
 The code of the language that you speak in the ISO 639-1 alpha-2 format. More...
 
std::string email
 Your valid email address. More...
 
unsigned int expires_in {0}
 (Optional) The number of seconds left before the access token expires. More...
 

Detailed Description

The federated (Facebook, Google, ArcGIS) sign-in properties structure.

Member Data Documentation

◆ country_code

std::string olp::authentication::AuthenticationClient::FederatedProperties::country_code

The code of the country in which you live in the ISO 3166-1 alpha-3 format.

Required for the first time sign-in; optional for the subsequent sign-ins.

◆ email

std::string olp::authentication::AuthenticationClient::FederatedProperties::email

Your valid email address.

Required for the first time sign-in and if your access token doesn't have the email permission; optional for the subsequent sign-ins.

◆ expires_in

unsigned int olp::authentication::AuthenticationClient::FederatedProperties::expires_in {0}

(Optional) The number of seconds left before the access token expires.

It must be equal to or more than zero. Ignored if it is zero or greater than the default expiration time supported by the application.

◆ language

std::string olp::authentication::AuthenticationClient::FederatedProperties::language

The code of the language that you speak in the ISO 639-1 alpha-2 format.

Required for the first time sign-in; optional for the subsequent sign-ins.


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