olp::authentication::AuthenticationClient::SignInProperties Struct Reference

General properties used to sign in with client credentials. More...

#include <AuthenticationClient.h>

Public Attributes
boost::optional< std::string >	scope {boost::none}
	(Optional) The scope assigned to the access token.
boost::optional< std::string >	device_id {boost::none}
	(Optional) The device ID assigned to the access token. More...
std::chrono::seconds	expires_in {0}
	(Optional) The number of seconds left before the access token expires. More...

Detailed Description

General properties used to sign in with client credentials.

Member Data Documentation

device_id

boost::optional<std::string> olp::authentication::AuthenticationClient::SignInProperties::device_id {boost::none}

(Optional) The device ID assigned to the access token.

Note

This field is only necessary if you want to apply a oauth rate limit on a particular device.

expires_in

std::chrono::seconds olp::authentication::AuthenticationClient::SignInProperties::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 access token endpoint.

---

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

• olp-cpp-sdk-authentication/include/olp/authentication/AuthenticationClient.h