Options used to configure the OAuth2 authentication process. More...

#include <CesiumClientCommon/OAuth2PKCE.h>

Public Attributes
std::string	clientID
	The OAuth2 client ID.

std::string	redirectPath
	The URL path that will be used to create the redirect URI.

std::optional< int >	redirectPort = std::nullopt
	The port that the internal HTTP server will listen on.

bool	useJsonBody
	Whether requests against the token and refresh endpoints should use a JSON body to the POST request.

Detailed Description

Options used to configure the OAuth2 authentication process.

Definition at line 36 of file OAuth2PKCE.h.

Member Data Documentation

◆ clientID

std::string CesiumClientCommon::OAuth2ClientOptions::clientID

The OAuth2 client ID.

Definition at line 40 of file OAuth2PKCE.h.

◆ redirectPath

std::string CesiumClientCommon::OAuth2ClientOptions::redirectPath

The URL path that will be used to create the redirect URI.

The final redirect URI will be http://127.0.0.1:<redirectPort>/<redirectPath>. This should match what is configured in the developer settings for the service you are authenticating with.

Definition at line 49 of file OAuth2PKCE.h.

◆ redirectPort

std::optional<int> CesiumClientCommon::OAuth2ClientOptions::redirectPort = std::nullopt

The port that the internal HTTP server will listen on.

If this is std::nullopt, a random available port will be chosen. You may need to explicitly specify the port if the API you are authenticating with requires a specific port to be provided in the developer settings.

Definition at line 57 of file OAuth2PKCE.h.

◆ useJsonBody

bool CesiumClientCommon::OAuth2ClientOptions::useJsonBody

Whether requests against the token and refresh endpoints should use a JSON body to the POST request.

If false, the body will be specified in the application/x-www-form-urlencoded format.

Definition at line 65 of file OAuth2PKCE.h.

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