OpenID Class

Properties   Methods   Events   Config Settings   Errors  

The OpenID class is used to verify the identify of a user as well as get basic profile information.

Syntax

OpenID

Remarks

The OpenID class implements an OpenID Connect (OIDC) Relying Party (RP) capable of authenticating a user and retrieving user information. OIDC is a simple identity layer on top of OAuth 2.0 and re-uses much of the functionality and concepts defined by OAuth 2.0.

To begin using the class you will first need to register your application with the service you want to use. During this process you should obtain a ClientId and ClientSecret. The following sections discuss the typical steps to verify the identity of a user and obtain profile information.

Get the Discovery Document

Many OpenID Providers (OPs) provide information via a Discovery Document. The discovery document defines information such as the endpoint URLs for authentication, tokens, and user information requests. Additionally, details about parameters such as supported authorization scopes are defined in this document. The document is found at a URL which can be fetched and parsed by calling the GetDiscoveryDoc method.

The discovery document URL is typically published by an OpenID Provider (OP) and must be known before calling this method. The format of the URL is standardized and typically takes the form:

https://www.youropenidserver.com/.well-known/openid-configuration

Call GetDiscoveryDoc before calling GetAuthorization to populate the class properties with information required to complete the authorization. The retrieved information includes endpoint URLs as well as the OpenID public certificates used to verify the signature on the ID token. After calling this method the following properties are populated:

• ServerAuthURL
• ServerTokenURL
• ServerUserInfoURL
• SignerCertURL

The above values may be stored, and later populated from the stored values, to avoid the requirement of calling GetDiscoveryDoc on subsequent authorization requests.

The following discovery document fields are populated after GetDiscoveryDoc returns:

• DiscoveryDocDetailsAuthorizationURL
• DiscoveryDocDetailsClaimsParamSupported
• DiscoveryDocDetailsIssuer
• DiscoveryDocDetailsSignerCertURL
• DiscoveryDocDetailsRegistrationURL
• DiscoveryDocDetailsServiceDocsURL
• DiscoveryDocDetailsSupportedClaims
• DiscoveryDocDetailsSupportedDisplays
• DiscoveryDocDetailsSupportedGrantTypes
• DiscoveryDocDetailsSupportedResponseTypes
• DiscoveryDocDetailsSupportedScopes
• DiscoveryDocDetailsTokenURL
• DiscoveryDocDetailsUserInfoURL

To access values not automatically parsed by the class the XPath configuration setting may be set to retrieve a specific value. Alternatively the RawJSON setting returns the entire JSON document which may be parsed separately.

Note: Calling GetDiscoveryDoc is not mandatory. If server information was stored from a previous call or is otherwise known ahead of time the following properties may be set in place of calling GetDiscoveryDoc:

• ServerAuthURL
• ServerTokenURL
• ServerUserInfoURL
• SignerCertURL or SignerCert

Examples of the above points: openid.GetDiscoveryDoc("https://accounts.google.com/.well-known/openid-configuration"); // ... or ... openid.ServerAuthURL = "https://accounts.google.com/o/oauth2/v2/auth"; openid.ServerTokenURL = "https://oauth2.googleapis.com/token"; openid.ServerUserInfoURL = "https://openidconnect.googleapis.com/v1/userinfo"; openid.SignerCertURL = "https://www.googleapis.com/oauth2/v3/certs"; // ... or ... string rawjson = openid.Config("RawJSON");

Get Authorization

Before calling GetAuthorization the class may be configured for one of several flows defined by the GrantType property. These flows determine which information is returned by the authorization server and which information (if any) is returned by the token server.

Possible values for GrantType are:

• 0 (Authorization Code - Default)
• 1 (Implicit)
• 2 (Hybrid)

When using 0 (Authorization Code Flow - Default), an authorization code is returned from the ServerAuthURL and the class automatically contacts the ServerTokenURL and exchanges the authorization code for an ID token and access token.

When using 1 (Implicit Flow), the ServerAuthURL returns an ID token and access token directly. This is only recommended for implementations that are in-browser, as this potentially exposes the tokens to the end-user and user agent itself.

When using 2 (Hybrid Flow), an authorization code and potentially one or more tokens are returned by the ServerAuthURL. The class will automatically contact the ServerTokenURL to exchange the authorization code for an ID token and access token.

When GrantType and any other optional settings are set as desired, call GetAuthorization.

GetAuthorization performs several operations automatically depending on the value of ClientProfile. Please see the introduction section for the OpenID class for a detailed overview of the typical scenarios.

After authorization is complete, UserDetails will be populated with the claims parsed from the ID token. This method also returns an authorization string. The authorization string grants access to additional resources as requested via the AuthorizationScope property. If access to another resource was requested, then the access token returned here may be set in the Authorization property of any other class (or passed as the value of the HTTP Authorization header).

GetUserInfo may be called after calling this method.

The following properties are applicable when calling this method:

• ClientId (required)
• ClientSecret (required)
• ServerAuthURL (required - populated by GetDiscoveryDoc.)
• ServerTokenURL (required - populated by GetDiscoveryDoc.)
• SignerCertURL (conditional - populated by GetDiscoveryDoc. Required if SignerCert is not set.)
• SignerCert (conditional - required if SignerCertURL is not set.)
• AuthorizationScope
• ClientProfile
• GrantType
• Params
• RefreshToken
• ReturnURL
• State
• Timeout
• Display
• Prompt
• IDTokenHint
• LoginHint
• ResponseType

For the default Authorization Code flow, GetAuthorization could work like this: openid.ClientId = "client id"; openid.ClientSecret = "client secret"; openid.AuthorizationScope += " profile email"; // default value is 'openid' openid.State = "application state"; string authToken = openid.GetAuthorization();

Get User Info

When GetAuthorization returns, the UserDetails property is populated with information about the user as returned in the ID token from the authorization server. An additional operation, GetUserInfo may optionally be called to query the ServerUserInfoURL for information about the user.

Before calling the GetUserInfo method, a successful call to GetAuthorization must be made. The access token returned by GetAuthorization is used by the OpenID provider at ServerUserInfoURL to identify the user for which claims are being retrieved.

When this method is called the class requests the claims about the user from the ServerUserInfoURL. The resulting claims are available in the UserDetail* properties.

Note: The GetUserInfo method will populate the UserDetail* properties with the claims returned in the ID token during the authorization process. This method may not need to be called in order to access the desired claims about the user.

openid.GetUserInfo(); // ... use the user info in the remainder of your application ...

Client Profile Notes

The ClientProfile defines the environment in which the class is being used, and controls how the class behaves in order to best suit that environment. Choose the profile that is closest to the runtime environment.

The following client types are currently supported by the class:

• Application (desktop application)
• WebServer (server side application such as a web site)
• Device (an application without browser access such as a game console)
• Mobile (phone or tablet application)
• Browser (javascript application)
• JWT (server to server authentication using a JWT bearer token such as Google service account authentication)

Application Profile

The Application profile is applicable to applications that are run directly by the user. For instance, a Windows form application would use the Application profile. To authorize your application (client) using the Application profile, use the following steps:

First, set ClientProfile to ocpApplication. This defines the profile the class will use. Set the ClientId, ClientSecret, ServerAuthURL, and ServerTokenURL to the values you obtained when registering your application.

Second, call GetAuthorization to begin the authorization process. When GetAuthorization is called, the class will build the URL to which the user will be directed and fire the LaunchBrowser event. The class will then launch the browser using the command and URL shown in the LaunchBrowser event and await the response. The duration for which the class will wait for a response is defined by BrowserResponseTimeout.

Third, the user will interact with the browser to authenticate and grant access to the connecting application. The user will then be redirected back to an embedded web server that was automatically started when GetAuthorization was called. At this time, the ReturnURL event will fire. This event provides an opportunity to provide a custom response to your user that they will see in their browser.

Fourth, the class will then automatically exchange the grant that was returned by the authorization server for the access token using the HTTP endpoint specified in ServerTokenURL.

The authorization is now complete and the GetAuthorization method will return the authorization string. The authorization string can then be used with any of our components by simply setting the returned value to the authorization property before making a request.

The following is a simple example: component.ClientId = "CLIENT_ID"; component.ClientSecret = "CLIENT_ID"; component.ServerAuthURL = "https://accounts.google.com/o/oauth2/auth"; component.ServerTokenURL = "https://accounts.google.com/o/oauth2/token"; HTTP.Authorization = component.GetAuthorization(); HTTP.Get("https://www.googleapis.com/oauth2/v1/userinfo");

Web Profile

The Web profile is applicable to applications that are run on the server side when the user uses the application from a web browser. To authorize your application (client) using this profile, use the following steps:

First, set ClientProfile to ocpWeb. This defines the profile the component will use. Set the ClientId, ClientSecret, ServerAuthURL, and ServerTokenURL to the values you obtained when registering your application. Set ReturnURL to the page on your site that will be the endpoint the user is redirected back to after authentication.

Second, call GetAuthorizationURL. This will return a URL to which the user should be redirected. Redirect the user to this URL.

Third, after the user authenticates and is returned to the page on your site specified by ReturnURL, parse the "code" query string parameter from the incoming request to get the authorization code from the authorization server. Then, set AuthorizationCode property to the parsed value.

Fourth, after AuthorizationCode is set, call GetAuthorization to exchange the code specified in AuthorizationCode for a token from the server specified by ServerTokenURL. GetAuthorization will then return the authorization string. The authorization string can be used with any of our components by simply setting the returned value to the authorization property before making a request.

For additional details for less common profile types please see ClientProfile.

Property List

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

AccessToken Property (OpenID Class)

This property includes the access token returned by the authorization server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAccessToken();
int SetAccessToken(const char* lpszAccessToken);

Unicode (Windows)
LPWSTR GetAccessToken();
INT SetAccessToken(LPCWSTR lpszAccessToken);

char* ipworksauth_openid_getaccesstoken(void* lpObj);
int ipworksauth_openid_setaccesstoken(void* lpObj, const char* lpszAccessToken);

QString GetAccessToken();
int SetAccessToken(QString qsAccessToken);

Default Value

""

Remarks

This property will be populated with the access token returned by the authorization server after a call to GetAuthorization. This will be the raw access token, whereas the return value from the GetAuthorization method will also include the required data so that it can be passed directly to the Authorization property of other components or added as the value of the authorization header in another client implementation.

Data Type

String

AccessTokenExp Property (OpenID Class)

This property includes the lifetime of the access token.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAccessTokenExp();

Unicode (Windows)
INT GetAccessTokenExp();

int ipworksauth_openid_getaccesstokenexp(void* lpObj);

int GetAccessTokenExp();

Default Value

0

Remarks

This setting holds the lifetime of the access token in seconds. For instance the value 3600 indicates that the token will expire in one hour from the time it was generated.

This property is read-only.

Data Type

Integer

AuthorizationCode Property (OpenID Class)

This property includes the authorization code that is exchanged for an access token.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAuthorizationCode();
int SetAuthorizationCode(const char* lpszAuthorizationCode);

Unicode (Windows)
LPWSTR GetAuthorizationCode();
INT SetAuthorizationCode(LPCWSTR lpszAuthorizationCode);

char* ipworksauth_openid_getauthorizationcode(void* lpObj);
int ipworksauth_openid_setauthorizationcode(void* lpObj, const char* lpszAuthorizationCode);

QString GetAuthorizationCode();
int SetAuthorizationCode(QString qsAuthorizationCode);

Default Value

""

Remarks

This property is used with the AuthorizationCode GrantType. When ClientProfile is set to ocpApplication (Application flow), this property will be informational only, as the GetAuthorization method will automatically exchange this code for a token with the authorization server specified in ServerTokenURL.

When ClientProfile is set to ocpWeb (Web flow), this property needs to be set to the authorization code returned from the authorization server. Typically, this value is parsed when the service redirects the user back to your website. See ClientProfile for more information.

If this property is set before calling GetAuthorization, the class will not make a request to the authorization sever and instead will attempt to exchange the code with the authorization server for an access token.

This property is not available at design time.

Data Type

String

AuthorizationScope Property (OpenID Class)

The authorization scope used during authorization.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAuthorizationScope();
int SetAuthorizationScope(const char* lpszAuthorizationScope);

Unicode (Windows)
LPWSTR GetAuthorizationScope();
INT SetAuthorizationScope(LPCWSTR lpszAuthorizationScope);

char* ipworksauth_openid_getauthorizationscope(void* lpObj);
int ipworksauth_openid_setauthorizationscope(void* lpObj, const char* lpszAuthorizationScope);

QString GetAuthorizationScope();
int SetAuthorizationScope(QString qsAuthorizationScope);

Default Value

"openid"

Remarks

This property specifies the authorization scopes sent in the authorization request. The value specified here must be a space separated list of scopes. For instance openid profile email.

The openid scope is always required to be present. The default value is openid.

After calling GetAuthorization this property will be updated with the scope sent in the response from the server and will indicate the scope that was actually granted.

Data Type

String

ClientId Property (OpenID Class)

This property includes the Id of the client assigned when registering the application.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetClientId();
int SetClientId(const char* lpszClientId);

Unicode (Windows)
LPWSTR GetClientId();
INT SetClientId(LPCWSTR lpszClientId);

char* ipworksauth_openid_getclientid(void* lpObj);
int ipworksauth_openid_setclientid(void* lpObj, const char* lpszClientId);

QString GetClientId();
int SetClientId(QString qsClientId);

Default Value

""

Remarks

This property holds the Id of the client that was assigned when initially registering the application with the authorization server. This value must be specified before calling GetAuthorization or GetAuthorizationURL.

Data Type

String

ClientProfile Property (OpenID Class)

This property includes the type of client that is requesting authorization.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetClientProfile();
int SetClientProfile(int iClientProfile);

Unicode (Windows)
INT GetClientProfile();
INT SetClientProfile(INT iClientProfile);

OCP_APPLICATION(0), 
OCP_WEB(1), 
OCP_DEVICE(2), 
OCP_MOBILE(3), 
OCP_JWT(4)

int ipworksauth_openid_getclientprofile(void* lpObj);
int ipworksauth_openid_setclientprofile(void* lpObj, int iClientProfile);

int GetClientProfile();
int SetClientProfile(int iClientProfile);

Default Value

0

Remarks

This defines the type of client that will be requesting authorization. Set this before calling GetAuthorization to inform the class to act accordingly. Possible values are as follows:

Application Profile

The Application profile is applicable to applications that are run directly by the user. For instance, a Windows form application would use the Application profile. To authorize your application (client) using the Application profile, use the following steps:

First, set ClientProfile to ocpApplication. This defines the profile the class will use. Set the ClientId, ClientSecret, ServerAuthURL, and ServerTokenURL to the values you obtained when registering your application.

Second, call GetAuthorization to begin the authorization process. When GetAuthorization is called, the class will build the URL to which the user will be directed and fire the LaunchBrowser event. The class will then launch the browser using the command and URL shown in the LaunchBrowser event and await the response. The duration for which the class will wait for a response is defined by BrowserResponseTimeout.

Third, the user will interact with the browser to authenticate and grant access to the connecting application. The user will then be redirected back to an embedded web server that was automatically started when GetAuthorization was called. At this time, the ReturnURL event will fire. This event provides an opportunity to provide a custom response to your user that they will see in their browser.

Fourth, the class will then automatically exchange the grant that was returned by the authorization server for the access token using the HTTP endpoint specified in ServerTokenURL.

The authorization is now complete and the GetAuthorization method will return the authorization string. The authorization string can then be used with any of our components by simply setting the returned value to the authorization property before making a request.

The following is a simple example: component.ClientId = "CLIENT_ID"; component.ClientSecret = "CLIENT_ID"; component.ServerAuthURL = "https://accounts.google.com/o/oauth2/auth"; component.ServerTokenURL = "https://accounts.google.com/o/oauth2/token"; HTTP.Authorization = component.GetAuthorization(); HTTP.Get("https://www.googleapis.com/oauth2/v1/userinfo");

Web Profile

The Web profile is applicable to applications that are run on the server side when the user uses the application from a web browser. To authorize your application (client) using this profile, use the following steps:

First, set ClientProfile to ocpWeb. This defines the profile the component will use. Set the ClientId, ClientSecret, ServerAuthURL, and ServerTokenURL to the values you obtained when registering your application. Set ReturnURL to the page on your site that will be the endpoint the user is redirected back to after authentication.

Second, call GetAuthorizationURL. This will return a URL to which the user should be redirected. Redirect the user to this URL.

Third, after the user authenticates and is returned to the page on your site specified by ReturnURL, parse the "code" query string parameter from the incoming request to get the authorization code from the authorization server. Then, set AuthorizationCode property to the parsed value.

Fourth, after AuthorizationCode is set, call GetAuthorization to exchange the code specified in AuthorizationCode for a token from the server specified by ServerTokenURL. GetAuthorization will then return the authorization string. The authorization string can be used with any of our components by simply setting the returned value to the authorization property before making a request.

Device Profile

The Device profile is applicable to applications that are run on devices for which a web browser cannot be used. For example, a game console would use the Device profile. To authorize your application (client) using the device client profile use the following steps:

First, set ClientProfile to ocpDevice. This defines the profile the class will use. Set the ClientId, ClientSecret, ServerAuthURL, and ServerTokenURL to the values you obtained when registering your application. Do not set ReturnURL.

Second, call GetAuthorizationURL. The class will automatically make a request to ServerAuthURL to obtain a user code for the device. The GetAuthorizationURL method will return the URL your user must visit from another device or computer that has web browser support. The GetAuthorizationURL method will also populate DeviceUserCode. This device user code must be provided to the user. The user will enter the code at the URL returned by GetAuthorizationURL.

Third, at this time, call GetAuthorization. The class will begin polling the server specified in ServerTokenURL. The polling interval is specified (in seconds) by the PollingInterval setting.

Fourth, after the user has authenticated, the GetAuthorization method will return the authorization string. To use the authorization string with any of our components, simply pass this value to the authorization property before making the request.

Mobile Profile

The Mobile profile is applicable to applications that are run on devices for which a web browser can be used. For instance, a mobile phone or tablet would use the Mobile profile. The behavior when using this profile is very similar to the Application profile. The only difference between the Mobile and Application profiles is the way the browser is launched. When set to the Mobile profile, the LaunchBrowser event will fire but the class will not attempt to launch the browser automatically. The browser must be launched manually from code. This behavior is the only difference between the Mobile and Application profiles. Please read the steps for the Application profile for a more detailed look at the process.

JWT Bearer Token (Server-to-Server) Profile

The JWT (JSON Web Token) Bearer Token profile is available for server-to-server authentication. For instance this may be used by web applications to access a Google service. In this case, the application will access data on behalf of the service account, not the end user. End-user interaction is not required.

First, specify AuthorizationScope ServerTokenURL and JWTServiceProvider.

Second, specify JWT-specific values. The use of the JWT profile also requires additional configuration settings to be specified, including a certificate with private key used to sign the JWT. Either specify the JWTJSONKey configuration setting, which will parse the necessary information automatically, or manually specify the following configuration settings:

• JWTIssuer (required)
• JWTAudience (required)
• JWTCertStoreType (required)
• JWTCertStore (required)
• JWTCertStorePassword (required)
• JWTCertSubject (required)
• JWTSubject
• JWTValidityTime
• JWTSignatureAlgorithm

Example 1. Google: oauth.AuthorizationScope = "https://www.googleapis.com/auth/analytics"; oauth.ServerTokenURL = "https://www.googleapis.com/oauth2/v3/token"; oauth.ClientProfile = OauthClientProfiles.ocpJWT; oauth.Config("JWTServiceProvider=0"); oauth.Config("JWTIssuer=CLIENT_ID"); oauth.Config("JWTAudience=https://www.googleapis.com/oauth2/v3/token"); oauth.Config("JWTCertStoreType=2"); oauth.Config("JWTCertStore=C:\\MyCertificate.p12"); oauth.Config("JWTCertStorePassword=password"); oauth.Config("JWTCertSubject=*"); oauth.Config("JWTValidityTime=5400"); //in seconds string authStr = oauth.GetAuthorization();

Example 2. Microsoft: oauth.ClientId = "Client_Id"; oauth.ClientProfile = OauthClientProfiles.ocpJWT; oauth.AuthorizationScope = "https://graph.microsoft.com/.default"; oauth.ServerTokenURL = "https://login.microsoftonline.com/" + tenant_id + "/oauth2/V2.0/token"; oauth.Config("JWTServiceProvider=1"); oauth.Config("JWTIssuer=" + CLIENT_ID); oauth.Config("JWTSubject=" + CLIENT_ID); oauth.Config("JWTCertStoreType=2"); oauth.Config("JWTCertStore=C:\\MyCertificate.p12"); oauth.Config("JWTCertStorePassword=password"); oauth.Config("JWTCertSubject=*"); oauth.Config("JWTValidityTime=3600"); oauth.Config("JWTAudience=https://login.microsoftonline.com/"+ tenant_id + "/oauth2/V2.0/token"); string authStr = oauth.GetAuthorization();

Data Type

Integer

ClientSecret Property (OpenID Class)

This property includes the secret value for the client assigned when registering the application.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetClientSecret();
int SetClientSecret(const char* lpszClientSecret);

Unicode (Windows)
LPWSTR GetClientSecret();
INT SetClientSecret(LPCWSTR lpszClientSecret);

char* ipworksauth_openid_getclientsecret(void* lpObj);
int ipworksauth_openid_setclientsecret(void* lpObj, const char* lpszClientSecret);

QString GetClientSecret();
int SetClientSecret(QString qsClientSecret);

Default Value

""

Remarks

This property holds the secret of the client that was assigned when initially registering the application with the authorization server. This value must be specified before calling GetAuthorization or GetAuthorizationURL.

Data Type

String

Connected Property (OpenID Class)

This shows whether the class is connected.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnected();
int SetConnected(int bConnected);

Unicode (Windows)
BOOL GetConnected();
INT SetConnected(BOOL bConnected);

int ipworksauth_openid_getconnected(void* lpObj);
int ipworksauth_openid_setconnected(void* lpObj, int bConnected);

bool GetConnected();
int SetConnected(bool bConnected);

Default Value

FALSE

Remarks

This property is used to determine whether or not the class is connected to the remote host.

Note: It is recommended to use the Connect or Disconnect method instead of setting this property.

This property is not available at design time.

Data Type

Boolean

CookieCount Property (OpenID Class)

The number of records in the Cookie arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCookieCount();
int SetCookieCount(int iCookieCount);

Unicode (Windows)
INT GetCookieCount();
INT SetCookieCount(INT iCookieCount);

int ipworksauth_openid_getcookiecount(void* lpObj);
int ipworksauth_openid_setcookiecount(void* lpObj, int iCookieCount);

int GetCookieCount();
int SetCookieCount(int iCookieCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

• CookieDomain
• CookieExpiration
• CookieName
• CookiePath
• CookieSecure
• CookieValue

The array indices start at 0 and end at CookieCount - 1.

This property is not available at design time.

Data Type

Integer

CookieDomain Property (OpenID Class)

This is the domain of a received cookie.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCookieDomain(int iCookieIndex);

Unicode (Windows)
LPWSTR GetCookieDomain(INT iCookieIndex);

char* ipworksauth_openid_getcookiedomain(void* lpObj, int cookieindex);

QString GetCookieDomain(int iCookieIndex);

Default Value

""

Remarks

This is the domain of a received cookie. This property contains a domain name to limit the cookie to (if provided by the server). If the server does not provide a domain name, this property will contain an empty string. The convention in this case is to use the server name specified by URLServer as the cookie domain.

The CookieIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CookieCount property.

This property is read-only and not available at design time.

Data Type

String

CookieExpiration Property (OpenID Class)

This property contains an expiration time for the cookie (if provided by the server).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCookieExpiration(int iCookieIndex);

Unicode (Windows)
LPWSTR GetCookieExpiration(INT iCookieIndex);

char* ipworksauth_openid_getcookieexpiration(void* lpObj, int cookieindex);

QString GetCookieExpiration(int iCookieIndex);

Default Value

""

Remarks

This property contains an expiration time for the cookie (if provided by the server). The time format used is "Weekday, DD-Mon-YY HH:MM:SS GMT". If the server does not provide an expiration time, this property will contain an empty string. The convention is to drop the cookie at the end of the session.

The CookieIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CookieCount property.

This property is read-only and not available at design time.

Data Type

String

CookieName Property (OpenID Class)

This property, contains the name of the cookie.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCookieName(int iCookieIndex);
int SetCookieName(int iCookieIndex, const char* lpszCookieName);

Unicode (Windows)
LPWSTR GetCookieName(INT iCookieIndex);
INT SetCookieName(INT iCookieIndex, LPCWSTR lpszCookieName);

char* ipworksauth_openid_getcookiename(void* lpObj, int cookieindex);
int ipworksauth_openid_setcookiename(void* lpObj, int cookieindex, const char* lpszCookieName);

QString GetCookieName(int iCookieIndex);
int SetCookieName(int iCookieIndex, QString qsCookieName);

Default Value

""

Remarks

This property, contains the name of the cookie.

This property, along with CookieValue, stores the cookie that is to be sent to the server. The SetCookie event displays the cookies sent by the server and their properties.

The CookieIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CookieCount property.

This property is not available at design time.

Data Type

String

CookiePath Property (OpenID Class)

This property contains a path name to limit the cookie to (if provided by the server).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCookiePath(int iCookieIndex);

Unicode (Windows)
LPWSTR GetCookiePath(INT iCookieIndex);

char* ipworksauth_openid_getcookiepath(void* lpObj, int cookieindex);

QString GetCookiePath(int iCookieIndex);

Default Value

""

Remarks

This property contains a path name to limit the cookie to (if provided by the server). If the server does not provide a cookie path, the path property will be an empty string. The convention in this case is to use the path specified by URLPath as the cookie path.

The CookieIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CookieCount property.

This property is read-only and not available at design time.

Data Type

String

CookieSecure Property (OpenID Class)

This property contains the security flag of the received cookie.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCookieSecure(int iCookieIndex);

Unicode (Windows)
BOOL GetCookieSecure(INT iCookieIndex);

int ipworksauth_openid_getcookiesecure(void* lpObj, int cookieindex);

bool GetCookieSecure(int iCookieIndex);

Default Value

FALSE

Remarks

This property contains the security flag of the received cookie. This property specifies whether the cookie is secure. If the value of this property is True, the cookie value must be submitted only through a secure (HTTPS) connection.

The CookieIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CookieCount property.

This property is read-only and not available at design time.

Data Type

Boolean

CookieValue Property (OpenID Class)

This property contains the value of the cookie.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCookieValue(int iCookieIndex);
int SetCookieValue(int iCookieIndex, const char* lpszCookieValue);

Unicode (Windows)
LPWSTR GetCookieValue(INT iCookieIndex);
INT SetCookieValue(INT iCookieIndex, LPCWSTR lpszCookieValue);

char* ipworksauth_openid_getcookievalue(void* lpObj, int cookieindex);
int ipworksauth_openid_setcookievalue(void* lpObj, int cookieindex, const char* lpszCookieValue);

QString GetCookieValue(int iCookieIndex);
int SetCookieValue(int iCookieIndex, QString qsCookieValue);

Default Value

""

Remarks

This property contains the value of the cookie. A corresponding value is associated with the cookie specified by CookieName. This property holds that value.

The SetCookie event provides the cookies set by the server.

The CookieIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CookieCount property.

This property is not available at design time.

Data Type

String

DiscoveryDocDetailsAuthorizationURL Property (OpenID Class)

This property holds the server authorization endpoint URL.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDiscoveryDocDetailsAuthorizationURL();

Unicode (Windows)
LPWSTR GetDiscoveryDocDetailsAuthorizationURL();

char* ipworksauth_openid_getdiscoverydocdetailsauthorizationurl(void* lpObj);

QString GetDiscoveryDocDetailsAuthorizationURL();

Default Value

""

Remarks

This property holds the server authorization endpoint URL.

This setting corresponds to the authorization_endpoint parameter in the discovery document.

This property is read-only and not available at design time.

Data Type

String

DiscoveryDocDetailsClaimsParamSupported Property (OpenID Class)

This property indicates whether the claims request parameter is supported by the Open ID provider.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetDiscoveryDocDetailsClaimsParamSupported();

Unicode (Windows)
BOOL GetDiscoveryDocDetailsClaimsParamSupported();

int ipworksauth_openid_getdiscoverydocdetailsclaimsparamsupported(void* lpObj);

bool GetDiscoveryDocDetailsClaimsParamSupported();

Default Value

FALSE

Remarks

This property indicates whether the claims request parameter is supported by the Open ID provider.

This setting corresponds to the claims_parameter_supported parameter in the discovery document.

This property is read-only and not available at design time.

Data Type

Boolean

DiscoveryDocDetailsIssuer Property (OpenID Class)

This property holds the issuer identifier of the OpenID provider.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDiscoveryDocDetailsIssuer();

Unicode (Windows)
LPWSTR GetDiscoveryDocDetailsIssuer();

char* ipworksauth_openid_getdiscoverydocdetailsissuer(void* lpObj);

QString GetDiscoveryDocDetailsIssuer();

Default Value

""

Remarks

This property holds the issuer identifier of the OpenID provider. This value is the same as the iss claim returned in ID tokens issued from this provider. The value is a URL with the https scheme with no query string or fragment component.

This setting corresponds to the issuer parameter in the discovery document.

This property is read-only and not available at design time.

Data Type

String

DiscoveryDocDetailsRegistrationURL Property (OpenID Class)

This property holds the dynamic client registration URL.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDiscoveryDocDetailsRegistrationURL();

Unicode (Windows)
LPWSTR GetDiscoveryDocDetailsRegistrationURL();

char* ipworksauth_openid_getdiscoverydocdetailsregistrationurl(void* lpObj);

QString GetDiscoveryDocDetailsRegistrationURL();

Default Value

""

Remarks

This property holds the dynamic client registration URL.

This setting corresponds to the registration_endpoint parameter in the discovery document.

This property is read-only and not available at design time.

Data Type

String

DiscoveryDocDetailsServiceDocsURL Property (OpenID Class)

This property contains the URL of the human-readable service documentation.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDiscoveryDocDetailsServiceDocsURL();

Unicode (Windows)
LPWSTR GetDiscoveryDocDetailsServiceDocsURL();

char* ipworksauth_openid_getdiscoverydocdetailsservicedocsurl(void* lpObj);

QString GetDiscoveryDocDetailsServiceDocsURL();

Default Value

""

Remarks

This property contains the URL of the human-readable service documentation. The information at this URL is intended for developers integrating with the OpenID provider and may contain useful information.

This setting corresponds to the service_documentation parameter in the discovery document.

This property is read-only and not available at design time.

Data Type

String

DiscoveryDocDetailsSignerCertURL Property (OpenID Class)

This property holds the URL of the JSON Web Key Set used to verify signatures on values returned by the OpenID provider.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDiscoveryDocDetailsSignerCertURL();

Unicode (Windows)
LPWSTR GetDiscoveryDocDetailsSignerCertURL();

char* ipworksauth_openid_getdiscoverydocdetailssignercerturl(void* lpObj);

QString GetDiscoveryDocDetailsSignerCertURL();

Default Value

""

Remarks

This property holds the URL of the JSON Web Key Set used to verify signatures on values returned by the OpenID provider. The signer keys are automatically retrieved by the class when the ID Token signature verification is performed.

This setting corresponds to the jwks_uri parameter in the discovery document.

This property is read-only and not available at design time.

Data Type

String

DiscoveryDocDetailsSupportedClaims Property (OpenID Class)

This property holds a comma separated list of claims that are supported by the OpenID provider.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDiscoveryDocDetailsSupportedClaims();

Unicode (Windows)
LPWSTR GetDiscoveryDocDetailsSupportedClaims();

char* ipworksauth_openid_getdiscoverydocdetailssupportedclaims(void* lpObj);

QString GetDiscoveryDocDetailsSupportedClaims();

Default Value

""

Remarks

This property holds a comma separated list of claims that are supported by the OpenID provider. For instance: aud,email,email_verified,exp,family_name,given_name,iat,iss,locale,name,picture,sub

This setting corresponds to the claims_supported parameter in the discovery document.

This property is read-only and not available at design time.

Data Type

String

DiscoveryDocDetailsSupportedDisplays Property (OpenID Class)

This property holds a comma separated list of display values that are supported by the OpenID provider.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDiscoveryDocDetailsSupportedDisplays();

Unicode (Windows)
LPWSTR GetDiscoveryDocDetailsSupportedDisplays();

char* ipworksauth_openid_getdiscoverydocdetailssupporteddisplays(void* lpObj);

QString GetDiscoveryDocDetailsSupportedDisplays();

Default Value

""

Remarks

This property holds a comma separated list of display values that are supported by the OpenID provider.

This setting corresponds to the display_values_supported parameter in the discovery document.

This property is read-only and not available at design time.

Data Type

String

DiscoveryDocDetailsSupportedGrantTypes Property (OpenID Class)

This property holds a comma separated list of grant types supported by the OpenID provider.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDiscoveryDocDetailsSupportedGrantTypes();

Unicode (Windows)
LPWSTR GetDiscoveryDocDetailsSupportedGrantTypes();

char* ipworksauth_openid_getdiscoverydocdetailssupportedgranttypes(void* lpObj);

QString GetDiscoveryDocDetailsSupportedGrantTypes();

Default Value

""

Remarks

This property holds a comma separated list of grant types supported by the OpenID provider. If this value is not specified by the OpenID provider it is specified that authorization_code and implicit are supported by the OpenID provider.

This setting corresponds to the grant_types_supported parameter in the discovery document.

This property is read-only and not available at design time.

Data Type

String

DiscoveryDocDetailsSupportedResponseTypes Property (OpenID Class)

This property hold a comma separated list of response types supported by the OpenID provider.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDiscoveryDocDetailsSupportedResponseTypes();

Unicode (Windows)
LPWSTR GetDiscoveryDocDetailsSupportedResponseTypes();

char* ipworksauth_openid_getdiscoverydocdetailssupportedresponsetypes(void* lpObj);

QString GetDiscoveryDocDetailsSupportedResponseTypes();

Default Value

""

Remarks

This property hold a comma separated list of response types supported by the OpenID provider. If this value is not specified by the OpenID provider it is defined that the OpenID provider supports (at a minimum) code, id_token, and token id_token values.

This setting corresponds to the response_types_supported parameter in the discovery document.

This property is read-only and not available at design time.

Data Type

String

DiscoveryDocDetailsSupportedScopes Property (OpenID Class)

This property hold a comma separated list of scopes that are supported by the OpenID provider.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDiscoveryDocDetailsSupportedScopes();

Unicode (Windows)
LPWSTR GetDiscoveryDocDetailsSupportedScopes();

char* ipworksauth_openid_getdiscoverydocdetailssupportedscopes(void* lpObj);

QString GetDiscoveryDocDetailsSupportedScopes();

Default Value

""

Remarks

This property hold a comma separated list of scopes that are supported by the OpenID provider. For instance: openid,email,profile

This setting corresponds to the scopes_supported parameter in the discovery document.

This property is read-only and not available at design time.

Data Type

String

DiscoveryDocDetailsTokenURL Property (OpenID Class)

This property holds the token endpoint URL.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDiscoveryDocDetailsTokenURL();

Unicode (Windows)
LPWSTR GetDiscoveryDocDetailsTokenURL();

char* ipworksauth_openid_getdiscoverydocdetailstokenurl(void* lpObj);

QString GetDiscoveryDocDetailsTokenURL();

Default Value

""

Remarks

This property holds the token endpoint URL.

This setting corresponds to the token_endpoint parameter in the discovery document.

This property is read-only and not available at design time.

Data Type

String

DiscoveryDocDetailsUserInfoURL Property (OpenID Class)

This property holds the user info endpoint URL.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDiscoveryDocDetailsUserInfoURL();

Unicode (Windows)
LPWSTR GetDiscoveryDocDetailsUserInfoURL();

char* ipworksauth_openid_getdiscoverydocdetailsuserinfourl(void* lpObj);

QString GetDiscoveryDocDetailsUserInfoURL();

Default Value

""

Remarks

This property holds the user info endpoint URL.

This setting corresponds to the userinfo_endpoint parameter in the discovery document.

This property is read-only and not available at design time.

Data Type

String

FirewallAutoDetect Property (OpenID Class)

This property tells the class whether or not to automatically detect and use firewall system settings, if available.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFirewallAutoDetect();
int SetFirewallAutoDetect(int bFirewallAutoDetect);

Unicode (Windows)
BOOL GetFirewallAutoDetect();
INT SetFirewallAutoDetect(BOOL bFirewallAutoDetect);

int ipworksauth_openid_getfirewallautodetect(void* lpObj);
int ipworksauth_openid_setfirewallautodetect(void* lpObj, int bFirewallAutoDetect);

bool GetFirewallAutoDetect();
int SetFirewallAutoDetect(bool bFirewallAutoDetect);

Default Value

FALSE

Remarks

This property tells the class whether or not to automatically detect and use firewall system settings, if available.

Data Type

Boolean

FirewallType Property (OpenID Class)

This property determines the type of firewall to connect through.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFirewallType();
int SetFirewallType(int iFirewallType);

Unicode (Windows)
INT GetFirewallType();
INT SetFirewallType(INT iFirewallType);

FW_NONE(0), 
FW_TUNNEL(1), 
FW_SOCKS4(2), 
FW_SOCKS5(3), 
FW_SOCKS4A(10)

int ipworksauth_openid_getfirewalltype(void* lpObj);
int ipworksauth_openid_setfirewalltype(void* lpObj, int iFirewallType);

int GetFirewallType();
int SetFirewallType(int iFirewallType);

Default Value

0

Remarks

This property determines the type of firewall to connect through. The applicable values are as follows:

Data Type

Integer

FirewallHost Property (OpenID Class)

This property contains the name or IP address of firewall (optional).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFirewallHost();
int SetFirewallHost(const char* lpszFirewallHost);

Unicode (Windows)
LPWSTR GetFirewallHost();
INT SetFirewallHost(LPCWSTR lpszFirewallHost);

char* ipworksauth_openid_getfirewallhost(void* lpObj);
int ipworksauth_openid_setfirewallhost(void* lpObj, const char* lpszFirewallHost);

QString GetFirewallHost();
int SetFirewallHost(QString qsFirewallHost);

Default Value

""

Remarks

This property contains the name or IP address of firewall (optional). If a FirewallHost is given, the requested connections will be authenticated through the specified firewall when connecting.

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the class fails with an error.

Data Type

String

FirewallPassword Property (OpenID Class)

This property contains a password if authentication is to be used when connecting through the firewall.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFirewallPassword();
int SetFirewallPassword(const char* lpszFirewallPassword);

Unicode (Windows)
LPWSTR GetFirewallPassword();
INT SetFirewallPassword(LPCWSTR lpszFirewallPassword);

char* ipworksauth_openid_getfirewallpassword(void* lpObj);
int ipworksauth_openid_setfirewallpassword(void* lpObj, const char* lpszFirewallPassword);

QString GetFirewallPassword();
int SetFirewallPassword(QString qsFirewallPassword);

Default Value

""

Remarks

This property contains a password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

Data Type

String

FirewallPort Property (OpenID Class)

This property contains the transmission control protocol (TCP) port for the firewall Host .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFirewallPort();
int SetFirewallPort(int iFirewallPort);

Unicode (Windows)
INT GetFirewallPort();
INT SetFirewallPort(INT iFirewallPort);

int ipworksauth_openid_getfirewallport(void* lpObj);
int ipworksauth_openid_setfirewallport(void* lpObj, int iFirewallPort);

int GetFirewallPort();
int SetFirewallPort(int iFirewallPort);

Default Value

0

Remarks

This property contains the transmission control protocol (TCP) port for the firewall FirewallHost. See the description of the FirewallHost property for details.

Note: This property is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.

Data Type

Integer

FirewallUser Property (OpenID Class)

This property contains a user name if authentication is to be used connecting through a firewall.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFirewallUser();
int SetFirewallUser(const char* lpszFirewallUser);

Unicode (Windows)
LPWSTR GetFirewallUser();
INT SetFirewallUser(LPCWSTR lpszFirewallUser);

char* ipworksauth_openid_getfirewalluser(void* lpObj);
int ipworksauth_openid_setfirewalluser(void* lpObj, const char* lpszFirewallUser);

QString GetFirewallUser();
int SetFirewallUser(QString qsFirewallUser);

Default Value

""

Remarks

This property contains a user name if authentication is to be used connecting through a firewall. If the FirewallHost is specified, this property and FirewallPassword properties are used to connect and authenticate to the given Firewall. If the authentication fails, the class fails with an error.

Data Type

String

FollowRedirects Property (OpenID Class)

This property determines what happens when the server issues a redirect.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFollowRedirects();
int SetFollowRedirects(int iFollowRedirects);

Unicode (Windows)
INT GetFollowRedirects();
INT SetFollowRedirects(INT iFollowRedirects);

FR_NEVER(0), 
FR_ALWAYS(1), 
FR_SAME_SCHEME(2)

int ipworksauth_openid_getfollowredirects(void* lpObj);
int ipworksauth_openid_setfollowredirects(void* lpObj, int iFollowRedirects);

int GetFollowRedirects();
int SetFollowRedirects(int iFollowRedirects);

Default Value

0

Remarks

This property determines what happens when the server issues a redirect. Normally, the class returns an error if the server responds with an "Object Moved" message. If this property is set to frAlways (1), the new URL for the object is retrieved automatically every time.

If this property is set to frSameScheme (2), the new URL is retrieved automatically only if the URLScheme is the same; otherwise, the class fails with an error.

Note: Following the HTTP specification, unless this property is set to frAlways (1), automatic redirects will be performed only for GET or HEAD requests. Other methods potentially could change the conditions of the initial request and create security vulnerabilities.

Furthermore, if either the new URL server or port are different from the existing one, User and Password are also reset to empty. If, however, this property is set to frAlways (1), the same credentials are used to connect to the new server.

A Redirect event is fired for every URL the product is redirected to. In the case of automatic redirections, the Redirect event is a good place to set properties related to the new connection (e.g., new authentication parameters).

The default value is frNever (0). In this case, redirects are never followed, and the class fails with an error instead.

Data Type

Integer

GrantType Property (OpenID Class)

The grant type defining the authentication flow.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetGrantType();
int SetGrantType(int iGrantType);

Unicode (Windows)
INT GetGrantType();
INT SetGrantType(INT iGrantType);

OGT_AUTHORIZATION_CODE(0), 
OGT_IMPLICIT(1), 
OGT_HYBRID(2)

int ipworksauth_openid_getgranttype(void* lpObj);
int ipworksauth_openid_setgranttype(void* lpObj, int iGrantType);

int GetGrantType();
int SetGrantType(int iGrantType);

Default Value

0

Remarks

This property defines the grant type used when performing authentication. The value specified here controls the authentication flow.

Possible values for GrantType are:

• 0 (Authorization Code - Default)
• 1 (Implicit)
• 2 (Hybrid)

When using 0 (Authorization Code Flow - Default), an authorization code is returned from the ServerAuthURL and the class automatically contacts the ServerTokenURL and exchanges the authorization code for an ID token and access token.

When using 1 (Implicit Flow), the ServerAuthURL returns an ID token and access token directly. This is only recommended for implementations that are in-browser, as this potentially exposes the tokens to the end-user and user agent itself.

When using 2 (Hybrid Flow), an authorization code and potentially one or more tokens are returned by the ServerAuthURL. The class will automatically contact the ServerTokenURL to exchange the authorization code for an ID token and access token.

Additional Notes

The response_type request parameter is automatically set based on the value specified here. In some cases multiple values are acceptable and a default value is chosen automatically. To explicitly specify a response_type value for the chosen grant type set ResponseType after setting this property.

Data Type

Integer

Idle Property (OpenID Class)

The current status of the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetIdle();

Unicode (Windows)
BOOL GetIdle();

int ipworksauth_openid_getidle(void* lpObj);

bool GetIdle();

Default Value

TRUE

Remarks

Idle will be False if the component is currently busy (communicating and/or waiting for an answer), and True at all other times.

This property is read-only.

Data Type

Boolean

LocalHost Property (OpenID Class)

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLocalHost();
int SetLocalHost(const char* lpszLocalHost);

Unicode (Windows)
LPWSTR GetLocalHost();
INT SetLocalHost(LPCWSTR lpszLocalHost);

char* ipworksauth_openid_getlocalhost(void* lpObj);
int ipworksauth_openid_setlocalhost(void* lpObj, const char* lpszLocalHost);

QString GetLocalHost();
int SetLocalHost(QString qsLocalHost);

Default Value

""

Remarks

The LocalHost property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.

If the class is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface).

NOTE: LocalHost is not persistent. You must always set it in code, and never in the property window.

Data Type

String

OtherHeaders Property (OpenID Class)

This property includes other headers as determined by the user (optional).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOtherHeaders();
int SetOtherHeaders(const char* lpszOtherHeaders);

Unicode (Windows)
LPWSTR GetOtherHeaders();
INT SetOtherHeaders(LPCWSTR lpszOtherHeaders);

char* ipworksauth_openid_getotherheaders(void* lpObj);
int ipworksauth_openid_setotherheaders(void* lpObj, const char* lpszOtherHeaders);

QString GetOtherHeaders();
int SetOtherHeaders(QString qsOtherHeaders);

Default Value

""

Remarks

This property can be set to a string of headers to be appended to the HTTP request headers created from other properties like ContentType and From.

The headers must follow the format Header: Value as described in the HTTP specifications. Header lines should be separated by CRLF ("\r\n") .

Use this property with caution. If this property contains invalid headers, HTTP requests may fail.

This property is useful for extending the functionality of the class beyond what is provided.

This property is not available at design time.

Data Type

String

ParamCount Property (OpenID Class)

The number of records in the Param arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetParamCount();
int SetParamCount(int iParamCount);

Unicode (Windows)
INT GetParamCount();
INT SetParamCount(INT iParamCount);

int ipworksauth_openid_getparamcount(void* lpObj);
int ipworksauth_openid_setparamcount(void* lpObj, int iParamCount);

int GetParamCount();
int SetParamCount(int iParamCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

• ParamName
• ParamValue

The array indices start at 0 and end at ParamCount - 1.

This property is not available at design time.

Data Type

Integer

ParamName Property (OpenID Class)

This property contains the name of the parameter to be used in the request or returned in the response.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetParamName(int iParamIndex);
int SetParamName(int iParamIndex, const char* lpszParamName);

Unicode (Windows)
LPWSTR GetParamName(INT iParamIndex);
INT SetParamName(INT iParamIndex, LPCWSTR lpszParamName);

char* ipworksauth_openid_getparamname(void* lpObj, int paramindex);
int ipworksauth_openid_setparamname(void* lpObj, int paramindex, const char* lpszParamName);

QString GetParamName(int iParamIndex);
int SetParamName(int iParamIndex, QString qsParamName);

Default Value

""

Remarks

This property contains the name of the parameter to be used in the request or returned in the response.

The ParamIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ParamCount property.

This property is not available at design time.

Data Type

String

ParamValue Property (OpenID Class)

This property contains the value of the parameter to be used in the request or returned in the response.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetParamValue(int iParamIndex);
int SetParamValue(int iParamIndex, const char* lpszParamValue);

Unicode (Windows)
LPWSTR GetParamValue(INT iParamIndex);
INT SetParamValue(INT iParamIndex, LPCWSTR lpszParamValue);

char* ipworksauth_openid_getparamvalue(void* lpObj, int paramindex);
int ipworksauth_openid_setparamvalue(void* lpObj, int paramindex, const char* lpszParamValue);

QString GetParamValue(int iParamIndex);
int SetParamValue(int iParamIndex, QString qsParamValue);

Default Value

""

Remarks

This property contains the value of the parameter to be used in the request or returned in the response. When issuing a request, the class will URL encode the value specified here. Returned values will be automatically URL decoded.

The ParamIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ParamCount property.

This property is not available at design time.

Data Type

String

ProxyAuthScheme Property (OpenID Class)

This property is used to tell the class which type of authorization to perform when connecting to the proxy.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxyAuthScheme();
int SetProxyAuthScheme(int iProxyAuthScheme);

Unicode (Windows)
INT GetProxyAuthScheme();
INT SetProxyAuthScheme(INT iProxyAuthScheme);

AUTH_BASIC(0), 
AUTH_DIGEST(1), 
AUTH_PROPRIETARY(2), 
AUTH_NONE(3), 
AUTH_NTLM(4), 
AUTH_NEGOTIATE(5)

int ipworksauth_openid_getproxyauthscheme(void* lpObj);
int ipworksauth_openid_setproxyauthscheme(void* lpObj, int iProxyAuthScheme);

int GetProxyAuthScheme();
int SetProxyAuthScheme(int iProxyAuthScheme);

Default Value

0

Remarks

This property is used to tell the class which type of authorization to perform when connecting to the proxy. This is used only when the ProxyUser and ProxyPassword properties are set.

ProxyAuthScheme should be set to authNone (3) when no authentication is expected.

By default, ProxyAuthScheme is authBasic (0), and if the ProxyUser and ProxyPassword properties are set, the component will attempt basic authentication.

If ProxyAuthScheme is set to authDigest (1), digest authentication will be attempted instead.

If ProxyAuthScheme is set to authProprietary (2), then the authorization token will not be generated by the class. Look at the configuration file for the class being used to find more information about manually setting this token.

If ProxyAuthScheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of ProxyUser and ProxyPassword.

Data Type

Integer

ProxyAutoDetect Property (OpenID Class)

This property tells the class whether or not to automatically detect and use proxy system settings, if available.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxyAutoDetect();
int SetProxyAutoDetect(int bProxyAutoDetect);

Unicode (Windows)
BOOL GetProxyAutoDetect();
INT SetProxyAutoDetect(BOOL bProxyAutoDetect);

int ipworksauth_openid_getproxyautodetect(void* lpObj);
int ipworksauth_openid_setproxyautodetect(void* lpObj, int bProxyAutoDetect);

bool GetProxyAutoDetect();
int SetProxyAutoDetect(bool bProxyAutoDetect);

Default Value

FALSE

Remarks

This property tells the class whether or not to automatically detect and use proxy system settings, if available. The default value is false.

Data Type

Boolean

ProxyPassword Property (OpenID Class)

This property contains a password if authentication is to be used for the proxy.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProxyPassword();
int SetProxyPassword(const char* lpszProxyPassword);

Unicode (Windows)
LPWSTR GetProxyPassword();
INT SetProxyPassword(LPCWSTR lpszProxyPassword);

char* ipworksauth_openid_getproxypassword(void* lpObj);
int ipworksauth_openid_setproxypassword(void* lpObj, const char* lpszProxyPassword);

QString GetProxyPassword();
int SetProxyPassword(QString qsProxyPassword);

Default Value

""

Remarks

This property contains a password if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

ProxyPort Property (OpenID Class)

This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxyPort();
int SetProxyPort(int iProxyPort);

Unicode (Windows)
INT GetProxyPort();
INT SetProxyPort(INT iProxyPort);

int ipworksauth_openid_getproxyport(void* lpObj);
int ipworksauth_openid_setproxyport(void* lpObj, int iProxyPort);

int GetProxyPort();
int SetProxyPort(int iProxyPort);

Default Value

80

Remarks

This property contains the Transmission Control Protocol (TCP) port for the proxy ProxyServer (default 80). See the description of the ProxyServer property for details.

Data Type

Integer

ProxyServer Property (OpenID Class)

If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProxyServer();
int SetProxyServer(const char* lpszProxyServer);

Unicode (Windows)
LPWSTR GetProxyServer();
INT SetProxyServer(LPCWSTR lpszProxyServer);

char* ipworksauth_openid_getproxyserver(void* lpObj);
int ipworksauth_openid_setproxyserver(void* lpObj, const char* lpszProxyServer);

QString GetProxyServer();
int SetProxyServer(QString qsProxyServer);

Default Value

""

Remarks

If a proxy ProxyServer is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

If the ProxyServer property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the ProxyServer property is set to the corresponding address. If the search is not successful, an error is returned.

Data Type

String

ProxySSL Property (OpenID Class)

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxySSL();
int SetProxySSL(int iProxySSL);

Unicode (Windows)
INT GetProxySSL();
INT SetProxySSL(INT iProxySSL);

PS_AUTOMATIC(0), 
PS_ALWAYS(1), 
PS_NEVER(2), 
PS_TUNNEL(3)

int ipworksauth_openid_getproxyssl(void* lpObj);
int ipworksauth_openid_setproxyssl(void* lpObj, int iProxySSL);

int GetProxySSL();
int SetProxySSL(int iProxySSL);

Default Value

0

Remarks

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:

Data Type

Integer

ProxyUser Property (OpenID Class)

This property contains a user name, if authentication is to be used for the proxy.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProxyUser();
int SetProxyUser(const char* lpszProxyUser);

Unicode (Windows)
LPWSTR GetProxyUser();
INT SetProxyUser(LPCWSTR lpszProxyUser);

char* ipworksauth_openid_getproxyuser(void* lpObj);
int ipworksauth_openid_setproxyuser(void* lpObj, const char* lpszProxyUser);

QString GetProxyUser();
int SetProxyUser(QString qsProxyUser);

Default Value

""

Remarks

This property contains a username if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

RefreshToken Property (OpenID Class)

This property specifies the refresh token received from or sent to the authorization server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRefreshToken();
int SetRefreshToken(const char* lpszRefreshToken);

Unicode (Windows)
LPWSTR GetRefreshToken();
INT SetRefreshToken(LPCWSTR lpszRefreshToken);

char* ipworksauth_openid_getrefreshtoken(void* lpObj);
int ipworksauth_openid_setrefreshtoken(void* lpObj, const char* lpszRefreshToken);

QString GetRefreshToken();
int SetRefreshToken(QString qsRefreshToken);

Default Value

""

Remarks

When GetAuthorization is called, if the authorization server returns a refresh token along with the access token, this property will hold the refresh token. Save this value for later use.

When your access token expires, set this property to the corresponding refresh token. Then call GetAuthorization, and the class will use this token to retrieve a new access token. The new authorization string will be returned by the GetAuthorization method. No user interaction is required when refreshing an access token.

Data Type

String

ReturnURL Property (OpenID Class)

This property includes the URL where the user (browser) returns after authenticating.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetReturnURL();
int SetReturnURL(const char* lpszReturnURL);

Unicode (Windows)
LPWSTR GetReturnURL();
INT SetReturnURL(LPCWSTR lpszReturnURL);

char* ipworksauth_openid_getreturnurl(void* lpObj);
int ipworksauth_openid_setreturnurl(void* lpObj, const char* lpszReturnURL);

QString GetReturnURL();
int SetReturnURL(QString qsReturnURL);

Default Value

""

Remarks

When ClientProfile is set to ocpApplication, this will be automatically set to the address of the local embedded web server. In that case, this property can be inspected to determine the URL where the user will be redirected, but it does not need to be set.

When calling GetAuthorizationURL, which is common when ClientProfile is set to ocpWeb, set this property to the URL on your server where the user will be redirected after authenticating with the authorization server.

This property corresponds to the redirect_uri query string parameter.

Data Type

String

ServerAuthURL Property (OpenID Class)

This property includes the URL of the authorization server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetServerAuthURL();
int SetServerAuthURL(const char* lpszServerAuthURL);

Unicode (Windows)
LPWSTR GetServerAuthURL();
INT SetServerAuthURL(LPCWSTR lpszServerAuthURL);

char* ipworksauth_openid_getserverauthurl(void* lpObj);
int ipworksauth_openid_setserverauthurl(void* lpObj, const char* lpszServerAuthURL);

QString GetServerAuthURL();
int SetServerAuthURL(QString qsServerAuthURL);

Default Value

""

Remarks

This property specifies the URL of the authorization server used when GetAuthorization is called. This value is used when constructing the URL to which the user will be redirected to authenticate and grant access.

This should be specified before calling GetAuthorization.

Data Type

String

ServerTokenURL Property (OpenID Class)

This property includes the URL used to obtain the access token.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetServerTokenURL();
int SetServerTokenURL(const char* lpszServerTokenURL);

Unicode (Windows)
LPWSTR GetServerTokenURL();
INT SetServerTokenURL(LPCWSTR lpszServerTokenURL);

char* ipworksauth_openid_getservertokenurl(void* lpObj);
int ipworksauth_openid_setservertokenurl(void* lpObj, const char* lpszServerTokenURL);

QString GetServerTokenURL();
int SetServerTokenURL(QString qsServerTokenURL);

Default Value

""

Remarks

The property specifies the URL where the grant will be exchanged for the access token. This is typically a separate HTTP endpoint on the authorization server.

This must be set before calling GetAuthorization.

Data Type

String

ServerUserInfoURL Property (OpenID Class)

The URL of the OpenID provider's user info endpoint.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetServerUserInfoURL();
int SetServerUserInfoURL(const char* lpszServerUserInfoURL);

Unicode (Windows)
LPWSTR GetServerUserInfoURL();
INT SetServerUserInfoURL(LPCWSTR lpszServerUserInfoURL);

char* ipworksauth_openid_getserveruserinfourl(void* lpObj);
int ipworksauth_openid_setserveruserinfourl(void* lpObj, const char* lpszServerUserInfoURL);

QString GetServerUserInfoURL();
int SetServerUserInfoURL(QString qsServerUserInfoURL);

Default Value

""

Remarks

This property holds the URL of the OpenID provider's user info endpoint. This value is required when calling GetUserInfo.

This property is populated when GetDiscoveryDoc is called.

Data Type

String

SignerCertEncoded Property (OpenID Class)

This is the certificate (PEM/base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSignerCertEncoded(char* &lpSignerCertEncoded, int &lenSignerCertEncoded);
int SetSignerCertEncoded(const char* lpSignerCertEncoded, int lenSignerCertEncoded);

Unicode (Windows)
INT GetSignerCertEncoded(LPSTR &lpSignerCertEncoded, INT &lenSignerCertEncoded);
INT SetSignerCertEncoded(LPCSTR lpSignerCertEncoded, INT lenSignerCertEncoded);

int ipworksauth_openid_getsignercertencoded(void* lpObj, char** lpSignerCertEncoded, int* lenSignerCertEncoded);
int ipworksauth_openid_setsignercertencoded(void* lpObj, const char* lpSignerCertEncoded, int lenSignerCertEncoded);

QByteArray GetSignerCertEncoded();
int SetSignerCertEncoded(QByteArray qbaSignerCertEncoded);

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SignerCertStore and SignerCertSubject properties also may be used to specify a certificate.

When SignerCertEncoded is set, a search is initiated in the current SignerCertStore for the private key of the certificate. If the key is found, SignerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SignerCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SignerCertStore Property (OpenID Class)

This is the name of the certificate store for the client certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSignerCertStore(char* &lpSignerCertStore, int &lenSignerCertStore);
int SetSignerCertStore(const char* lpSignerCertStore, int lenSignerCertStore);

Unicode (Windows)
INT GetSignerCertStore(LPSTR &lpSignerCertStore, INT &lenSignerCertStore);
INT SetSignerCertStore(LPCSTR lpSignerCertStore, INT lenSignerCertStore);

int ipworksauth_openid_getsignercertstore(void* lpObj, char** lpSignerCertStore, int* lenSignerCertStore);
int ipworksauth_openid_setsignercertstore(void* lpObj, const char* lpSignerCertStore, int lenSignerCertStore);

QByteArray GetSignerCertStore();
int SetSignerCertStore(QByteArray qbaSignerCertStore);

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The SignerCertStoreType property denotes the type of the certificate store specified by SignerCertStore. If the store is password protected, specify the password in SignerCertStorePassword.

SignerCertStore is used in conjunction with the SignerCertSubject property to specify client certificates. If SignerCertStore has a value, and SignerCertSubject or SignerCertEncoded is set, a search for a certificate is initiated. Please see the SignerCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Binary String

SignerCertStorePassword Property (OpenID Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSignerCertStorePassword();
int SetSignerCertStorePassword(const char* lpszSignerCertStorePassword);

Unicode (Windows)
LPWSTR GetSignerCertStorePassword();
INT SetSignerCertStorePassword(LPCWSTR lpszSignerCertStorePassword);

char* ipworksauth_openid_getsignercertstorepassword(void* lpObj);
int ipworksauth_openid_setsignercertstorepassword(void* lpObj, const char* lpszSignerCertStorePassword);

QString GetSignerCertStorePassword();
int SetSignerCertStorePassword(QString qsSignerCertStorePassword);

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SignerCertStoreType Property (OpenID Class)

This is the type of certificate store for this certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSignerCertStoreType();
int SetSignerCertStoreType(int iSignerCertStoreType);

Unicode (Windows)
INT GetSignerCertStoreType();
INT SetSignerCertStoreType(INT iSignerCertStoreType);

CST_USER(0), 
CST_MACHINE(1), 
CST_PFXFILE(2), 
CST_PFXBLOB(3), 
CST_JKSFILE(4), 
CST_JKSBLOB(5), 
CST_PEMKEY_FILE(6), 
CST_PEMKEY_BLOB(7), 
CST_PUBLIC_KEY_FILE(8), 
CST_PUBLIC_KEY_BLOB(9), 
CST_SSHPUBLIC_KEY_BLOB(10), 
CST_P7BFILE(11), 
CST_P7BBLOB(12), 
CST_SSHPUBLIC_KEY_FILE(13), 
CST_PPKFILE(14), 
CST_PPKBLOB(15), 
CST_XMLFILE(16), 
CST_XMLBLOB(17), 
CST_JWKFILE(18), 
CST_JWKBLOB(19), 
CST_SECURITY_KEY(20), 
CST_BCFKSFILE(21), 
CST_BCFKSBLOB(22), 
CST_PKCS11(23), 
CST_AUTO(99)

int ipworksauth_openid_getsignercertstoretype(void* lpObj);
int ipworksauth_openid_setsignercertstoretype(void* lpObj, int iSignerCertStoreType);

int GetSignerCertStoreType();
int SetSignerCertStoreType(int iSignerCertStoreType);

Default Value

0

Remarks

This is the type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

Data Type

Integer

SignerCertSubject Property (OpenID Class)

This is the subject of the certificate used for client authentication.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSignerCertSubject();
int SetSignerCertSubject(const char* lpszSignerCertSubject);

Unicode (Windows)
LPWSTR GetSignerCertSubject();
INT SetSignerCertSubject(LPCWSTR lpszSignerCertSubject);

char* ipworksauth_openid_getsignercertsubject(void* lpObj);
int ipworksauth_openid_setsignercertsubject(void* lpObj, const char* lpszSignerCertSubject);

QString GetSignerCertSubject();
int SetSignerCertSubject(QString qsSignerCertSubject);

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

SignerCertURL Property (OpenID Class)

The URL of the OpenID provider's signing certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSignerCertURL();
int SetSignerCertURL(const char* lpszSignerCertURL);

Unicode (Windows)
LPWSTR GetSignerCertURL();
INT SetSignerCertURL(LPCWSTR lpszSignerCertURL);

char* ipworksauth_openid_getsignercerturl(void* lpObj);
int ipworksauth_openid_setsignercerturl(void* lpObj, const char* lpszSignerCertURL);

QString GetSignerCertURL();
int SetSignerCertURL(QString qsSignerCertURL);

Default Value

""

Remarks

This property holds the URL of the OpenID provider's signing certificate. The signing certificate is used to very the signature of the ID token returned when calling GetAuthorization.

When calling GetAuthorization either SignerCertURL or SignerCert must be specified.

This property is populated when GetDiscoveryDoc is called.

Data Type

String

SSLAcceptServerCertEncoded Property (OpenID Class)

This is the certificate (PEM/base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLAcceptServerCertEncoded(char* &lpSSLAcceptServerCertEncoded, int &lenSSLAcceptServerCertEncoded);
int SetSSLAcceptServerCertEncoded(const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

Unicode (Windows)
INT GetSSLAcceptServerCertEncoded(LPSTR &lpSSLAcceptServerCertEncoded, INT &lenSSLAcceptServerCertEncoded);
INT SetSSLAcceptServerCertEncoded(LPCSTR lpSSLAcceptServerCertEncoded, INT lenSSLAcceptServerCertEncoded);

int ipworksauth_openid_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int ipworksauth_openid_setsslacceptservercertencoded(void* lpObj, const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

QByteArray GetSSLAcceptServerCertEncoded();
int SetSSLAcceptServerCertEncoded(QByteArray qbaSSLAcceptServerCertEncoded);

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.

When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SSLCertEncoded Property (OpenID Class)

This is the certificate (PEM/base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertEncoded(char* &lpSSLCertEncoded, int &lenSSLCertEncoded);
int SetSSLCertEncoded(const char* lpSSLCertEncoded, int lenSSLCertEncoded);

Unicode (Windows)
INT GetSSLCertEncoded(LPSTR &lpSSLCertEncoded, INT &lenSSLCertEncoded);
INT SetSSLCertEncoded(LPCSTR lpSSLCertEncoded, INT lenSSLCertEncoded);

int ipworksauth_openid_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int ipworksauth_openid_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);

QByteArray GetSSLCertEncoded();
int SetSSLCertEncoded(QByteArray qbaSSLCertEncoded);

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.

When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SSLCertStore Property (OpenID Class)

This is the name of the certificate store for the client certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertStore(char* &lpSSLCertStore, int &lenSSLCertStore);
int SetSSLCertStore(const char* lpSSLCertStore, int lenSSLCertStore);

Unicode (Windows)
INT GetSSLCertStore(LPSTR &lpSSLCertStore, INT &lenSSLCertStore);
INT SetSSLCertStore(LPCSTR lpSSLCertStore, INT lenSSLCertStore);

int ipworksauth_openid_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int ipworksauth_openid_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);

QByteArray GetSSLCertStore();
int SetSSLCertStore(QByteArray qbaSSLCertStore);

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Binary String

SSLCertStorePassword Property (OpenID Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSLCertStorePassword();
int SetSSLCertStorePassword(const char* lpszSSLCertStorePassword);

Unicode (Windows)
LPWSTR GetSSLCertStorePassword();
INT SetSSLCertStorePassword(LPCWSTR lpszSSLCertStorePassword);

char* ipworksauth_openid_getsslcertstorepassword(void* lpObj);
int ipworksauth_openid_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);

QString GetSSLCertStorePassword();
int SetSSLCertStorePassword(QString qsSSLCertStorePassword);

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SSLCertStoreType Property (OpenID Class)

This is the type of certificate store for this certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

Unicode (Windows)
INT GetSSLCertStoreType();
INT SetSSLCertStoreType(INT iSSLCertStoreType);

CST_USER(0), 
CST_MACHINE(1), 
CST_PFXFILE(2), 
CST_PFXBLOB(3), 
CST_JKSFILE(4), 
CST_JKSBLOB(5), 
CST_PEMKEY_FILE(6), 
CST_PEMKEY_BLOB(7), 
CST_PUBLIC_KEY_FILE(8), 
CST_PUBLIC_KEY_BLOB(9), 
CST_SSHPUBLIC_KEY_BLOB(10), 
CST_P7BFILE(11), 
CST_P7BBLOB(12), 
CST_SSHPUBLIC_KEY_FILE(13), 
CST_PPKFILE(14), 
CST_PPKBLOB(15), 
CST_XMLFILE(16), 
CST_XMLBLOB(17), 
CST_JWKFILE(18), 
CST_JWKBLOB(19), 
CST_SECURITY_KEY(20), 
CST_BCFKSFILE(21), 
CST_BCFKSBLOB(22), 
CST_PKCS11(23), 
CST_AUTO(99)

int ipworksauth_openid_getsslcertstoretype(void* lpObj);
int ipworksauth_openid_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);

int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

Default Value

0

Remarks

This is the type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

Data Type

Integer

SSLCertSubject Property (OpenID Class)

This is the subject of the certificate used for client authentication.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSLCertSubject();
int SetSSLCertSubject(const char* lpszSSLCertSubject);

Unicode (Windows)
LPWSTR GetSSLCertSubject();
INT SetSSLCertSubject(LPCWSTR lpszSSLCertSubject);

char* ipworksauth_openid_getsslcertsubject(void* lpObj);
int ipworksauth_openid_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);

QString GetSSLCertSubject();
int SetSSLCertSubject(QString qsSSLCertSubject);

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

SSLProvider Property (OpenID Class)

This specifies the SSL/TLS implementation to use.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

Unicode (Windows)
INT GetSSLProvider();
INT SetSSLProvider(INT iSSLProvider);

SSLP_AUTOMATIC(0), 
SSLP_PLATFORM(1), 
SSLP_INTERNAL(2)

int ipworksauth_openid_getsslprovider(void* lpObj);
int ipworksauth_openid_setsslprovider(void* lpObj, int iSSLProvider);

int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic) the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are:

In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform.

When Automatic is selected, on Windows the class will use the platform implementation. On Linux/macOS the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used on all platforms.

Data Type

Integer

SSLServerCertEncoded Property (OpenID Class)

This is the certificate (PEM/base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLServerCertEncoded(char* &lpSSLServerCertEncoded, int &lenSSLServerCertEncoded);

Unicode (Windows)
INT GetSSLServerCertEncoded(LPSTR &lpSSLServerCertEncoded, INT &lenSSLServerCertEncoded);

int ipworksauth_openid_getsslservercertencoded(void* lpObj, char** lpSSLServerCertEncoded, int* lenSSLServerCertEncoded);

QByteArray GetSSLServerCertEncoded();

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.

When SSLServerCertEncoded is set, a search is initiated in the current SSLServerCertStore for the private key of the certificate. If the key is found, SSLServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLServerCertSubject is set to an empty string.

This property is read-only and not available at design time.

Data Type

Binary String

State Property (OpenID Class)

Opaque value used to maintain state between the request and response.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetState();
int SetState(const char* lpszState);

Unicode (Windows)
LPWSTR GetState();
INT SetState(LPCWSTR lpszState);

char* ipworksauth_openid_getstate(void* lpObj);
int ipworksauth_openid_setstate(void* lpObj, const char* lpszState);

QString GetState();
int SetState(QString qsState);

Default Value

""

Remarks

This property optionally holds a string value which will be returned by the authorization server with the response.

Any value may be specified here and it will be returned exactly as it was sent. This can be used to maintain state within the application, and also may be used for security purposes (for instance to prevent Cross-Site Request Forgery). The contents of this property are treated as an opaque value.

When ClientProfile is set to ocpApplication the ReturnURL event provides the state value returned by the authorization server.

Data Type

String

Timeout Property (OpenID Class)

A timeout for the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTimeout();
int SetTimeout(int iTimeout);

Unicode (Windows)
INT GetTimeout();
INT SetTimeout(INT iTimeout);

int ipworksauth_openid_gettimeout(void* lpObj);
int ipworksauth_openid_settimeout(void* lpObj, int iTimeout);

int GetTimeout();
int SetTimeout(int iTimeout);

Default Value

60

Remarks

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If Timeout is set to a positive value, the class will wait for the operation to complete before returning control.

The class will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not "freeze" and remains responsive.

If Timeout expires, and the operation is not yet complete, the class fails with an error.

Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

Data Type

Integer

TransferredData Property (OpenID Class)

This property includes the contents of the last response from the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTransferredData(char* &lpTransferredData, int &lenTransferredData);

Unicode (Windows)
INT GetTransferredData(LPSTR &lpTransferredData, INT &lenTransferredData);

int ipworksauth_openid_gettransferreddata(void* lpObj, char** lpTransferredData, int* lenTransferredData);

QByteArray GetTransferredData();

Default Value

""

Remarks

This property contains the contents of the last response from the server.

TransferredDataLimit controls the maximum amount of data accumulated in TransferredData (by default, there is no limit).

This property is read-only and not available at design time.

Data Type

Binary String

TransferredHeaders Property (OpenID Class)

This property includes the full set of headers as received from the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTransferredHeaders();

Unicode (Windows)
LPWSTR GetTransferredHeaders();

char* ipworksauth_openid_gettransferredheaders(void* lpObj);

QString GetTransferredHeaders();

Default Value

""

Remarks

This property returns the complete set of raw headers as received from the server.

The Header event shows the individual headers as parsed by the class.

This property is read-only and not available at design time.

Data Type

String

UsePKCE Property (OpenID Class)

This property specifies if Proof Key for Code Exchange (PKCE) should be used.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetUsePKCE();
int SetUsePKCE(int bUsePKCE);

Unicode (Windows)
BOOL GetUsePKCE();
INT SetUsePKCE(BOOL bUsePKCE);

int ipworksauth_openid_getusepkce(void* lpObj);
int ipworksauth_openid_setusepkce(void* lpObj, int bUsePKCE);

bool GetUsePKCE();
int SetUsePKCE(bool bUsePKCE);

Default Value

FALSE

Remarks

If specified, Proof Key for Code Exchange (PKCE) defined by RFC 7636 will be used when GetAuthorization is called. This applies when using the Authorization Code GrantType. The PKCEChallengeEncoding configuration setting can be used to control the code challenge method that will be used. When using the ocpWeb ClientProfile, the PKCEVerifier configuration setting can be used to get/set the verifier that was used to generate the challenge. See the PKCEVerifier documentation for more information.

Data Type

Boolean

UserDetailsAddrCountry Property (OpenID Class)

This property holds the country name portion of the user's address.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetUserDetailsAddrCountry();

Unicode (Windows)
LPWSTR GetUserDetailsAddrCountry();

char* ipworksauth_openid_getuserdetailsaddrcountry(void* lpObj);

QString GetUserDetailsAddrCountry();

Default Value

""

Remarks

This property holds the country name portion of the user's address.

This property is read-only and not available at design time.

Data Type

String

UserDetailsAddrFormatted Property (OpenID Class)

This property holds the full mailing address of the user, formatted for display or use on a mailing label.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetUserDetailsAddrFormatted();

Unicode (Windows)
LPWSTR GetUserDetailsAddrFormatted();

char* ipworksauth_openid_getuserdetailsaddrformatted(void* lpObj);

QString GetUserDetailsAddrFormatted();

Default Value

""

Remarks

This property holds the full mailing address of the user, formatted for display or use on a mailing label. This value may contain multiple lines.

This property is read-only and not available at design time.

Data Type

String

UserDetailsAddrLocality Property (OpenID Class)

This property holds the city or locality portion of the user's address.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetUserDetailsAddrLocality();

Unicode (Windows)
LPWSTR GetUserDetailsAddrLocality();

char* ipworksauth_openid_getuserdetailsaddrlocality(void* lpObj);

QString GetUserDetailsAddrLocality();

Default Value

""

Remarks

This property holds the city or locality portion of the user's address.

This property is read-only and not available at design time.

Data Type

String

UserDetailsAddrPostalCode Property (OpenID Class)

This property holds the zip code or postal code portion of the user's address.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetUserDetailsAddrPostalCode();

Unicode (Windows)
LPWSTR GetUserDetailsAddrPostalCode();

char* ipworksauth_openid_getuserdetailsaddrpostalcode(void* lpObj);

QString GetUserDetailsAddrPostalCode();

Default Value

""

Remarks

This property holds the zip code or postal code portion of the user's address.

This property is read-only and not available at design time.

Data Type

String

UserDetailsAddrRegion Property (OpenID Class)

This property holds the state, province, prefecture, or region portion of the user's address.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetUserDetailsAddrRegion();

Unicode (Windows)
LPWSTR GetUserDetailsAddrRegion();

char* ipworksauth_openid_getuserdetailsaddrregion(void* lpObj);

QString GetUserDetailsAddrRegion();

Default Value

""

Remarks

This property holds the state, province, prefecture, or region portion of the user's address.

This property is read-only and not available at design time.

Data Type

String

UserDetailsAddrStreetAddr Property (OpenID Class)

This property holds the street address portion of the user's address.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetUserDetailsAddrStreetAddr();

Unicode (Windows)
LPWSTR GetUserDetailsAddrStreetAddr();

char* ipworksauth_openid_getuserdetailsaddrstreetaddr(void* lpObj);

QString GetUserDetailsAddrStreetAddr();

Default Value

""

Remarks

This property holds the street address portion of the user's address. This is the full street address which may include house number, street name, post office box, and multi-line extended street information. This value may contain multiple lines.

This property is read-only and not available at design time.

Data Type

String

UserDetailsAudiences Property (OpenID Class)

This property contains a comma separated list of audiences for which the user information is intended.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetUserDetailsAudiences();

Unicode (Windows)
LPWSTR GetUserDetailsAudiences();

char* ipworksauth_openid_getuserdetailsaudiences(void* lpObj);

QString GetUserDetailsAudiences();

Default Value

""

Remarks

This property contains a comma separated list of audiences for which the user information is intended.

This property is read-only and not available at design time.

Data Type

String

UserDetailsBirthday Property (OpenID Class)

This property contains the user's birthday.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetUserDetailsBirthday();

Unicode (Windows)
LPWSTR GetUserDetailsBirthday();

char* ipworksauth_openid_getuserdetailsbirthday(void* lpObj);

QString GetUserDetailsBirthday();

Default Value

""

Remarks

This property contains the user's birthday. The format of the value is YYYY-MM-DD or YYYY. The year may be 0000 to indicate it was omitted.

This property is read-only and not available at design time.

Data Type

String

UserDetailsEmail Property (OpenID Class)

This property contains the user's preferred email address.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetUserDetailsEmail();

Unicode (Windows)
LPWSTR GetUserDetailsEmail();

char* ipworksauth_openid_getuserdetailsemail(void* lpObj);

QString GetUserDetailsEmail();

Default Value

""

Remarks

This property contains the user's preferred email address.

This property is read-only and not available at design time.

Data Type

String

UserDetailsEmailVerified Property (OpenID Class)

This property indicates whether the user's email address has been verified.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetUserDetailsEmailVerified();

Unicode (Windows)
BOOL GetUserDetailsEmailVerified();

int ipworksauth_openid_getuserdetailsemailverified(void* lpObj);

bool GetUserDetailsEmailVerified();

Default Value

FALSE

Remarks

This property indicates whether the user's email address has been verified. To be considered verified the end-user must prove the email address was under the user's control at the time of verification.

This property is read-only and not available at design time.

Data Type

Boolean

UserDetailsFirstName Property (OpenID Class)

This property holds the first name of the user.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetUserDetailsFirstName();

Unicode (Windows)
LPWSTR GetUserDetailsFirstName();

char* ipworksauth_openid_getuserdetailsfirstname(void* lpObj);

QString GetUserDetailsFirstName();

Default Value

""

Remarks

This property holds the first name of the user. If multiple names are present they are space separated.

This property is read-only and not available at design time.

Data Type

String

UserDetailsGender Property (OpenID Class)

This property holds the user's gender.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetUserDetailsGender();

Unicode (Windows)
LPWSTR GetUserDetailsGender();

char* ipworksauth_openid_getuserdetailsgender(void* lpObj);

QString GetUserDetailsGender();

Default Value

""

Remarks

This property holds the user's gender. Defined values are male and female but other values may also be used.

This property is read-only and not available at design time.

Data Type

String

UserDetailsIssuer Property (OpenID Class)

This property contains the identifier of the issuer who issued the ID token.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetUserDetailsIssuer();

Unicode (Windows)
LPWSTR GetUserDetailsIssuer();

char* ipworksauth_openid_getuserdetailsissuer(void* lpObj);

QString GetUserDetailsIssuer();

Default Value

""

Remarks

This property contains the identifier of the issuer who issued the ID token.

This property is read-only and not available at design time.

Data Type

String

UserDetailsLastName Property (OpenID Class)

This property holds the last name of the user.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetUserDetailsLastName();

Unicode (Windows)
LPWSTR GetUserDetailsLastName();

char* ipworksauth_openid_getuserdetailslastname(void* lpObj);

QString GetUserDetailsLastName();

Default Value

""

Remarks

This property holds the last name of the user. If multiple names are present they are space separated.

This property is read-only and not available at design time.

Data Type

String

UserDetailsLocale Property (OpenID Class)

This property holds the end user's locale.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetUserDetailsLocale();

Unicode (Windows)
LPWSTR GetUserDetailsLocale();

char* ipworksauth_openid_getuserdetailslocale(void* lpObj);

QString GetUserDetailsLocale();

Default Value

""

Remarks

This property holds the end user's locale. This is represented as a BCP47 (RFC 5646) language tag. For instance en-US or en_US.

This property is read-only and not available at design time.

Data Type

String

UserDetailsMiddleName Property (OpenID Class)

This property holds the middle name of the user.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetUserDetailsMiddleName();

Unicode (Windows)
LPWSTR GetUserDetailsMiddleName();

char* ipworksauth_openid_getuserdetailsmiddlename(void* lpObj);

QString GetUserDetailsMiddleName();

Default Value

""

Remarks

This property holds the middle name of the user. If multiple names are present they are space separated.

This property is read-only and not available at design time.

Data Type

String

UserDetailsName Property (OpenID Class)

This property contains the user's full name in displayable form including all name parts.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetUserDetailsName();

Unicode (Windows)
LPWSTR GetUserDetailsName();

char* ipworksauth_openid_getuserdetailsname(void* lpObj);

QString GetUserDetailsName();

Default Value

""

Remarks

This property contains the user's full name in displayable form including all name parts. This may include titles and suffixes.

This property is read-only and not available at design time.

Data Type

String

UserDetailsNickname Property (OpenID Class)

This property holds the casual name of the user.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetUserDetailsNickname();

Unicode (Windows)
LPWSTR GetUserDetailsNickname();

char* ipworksauth_openid_getuserdetailsnickname(void* lpObj);

QString GetUserDetailsNickname();

Default Value

""

Remarks

This property holds the casual name of the user. This may or may not be the same as UserDetailsFirstName.

This property is read-only and not available at design time.

Data Type

String

UserDetailsPhoneNumber Property (OpenID Class)

This property holds the user's phone number.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetUserDetailsPhoneNumber();

Unicode (Windows)
LPWSTR GetUserDetailsPhoneNumber();

char* ipworksauth_openid_getuserdetailsphonenumber(void* lpObj);

QString GetUserDetailsPhoneNumber();

Default Value

""

Remarks

This property holds the user's phone number. This may be in E.164 format, for instance +1 (425) 555-1212. If an extension is present it may be represented according to RFC 3966. For instance: +1 (604) 555-1234;ext=5678.

This property is read-only and not available at design time.

Data Type

String

UserDetailsPhoneNumberVerified Property (OpenID Class)

This property indicates whether the user's phone number has been verified.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetUserDetailsPhoneNumberVerified();

Unicode (Windows)
BOOL GetUserDetailsPhoneNumberVerified();

int ipworksauth_openid_getuserdetailsphonenumberverified(void* lpObj);

bool GetUserDetailsPhoneNumberVerified();

Default Value

FALSE

Remarks

This property indicates whether the user's phone number has been verified. To be considered verified the end-user must prove the phone number was under the user's control at the time of verification.

This property is read-only and not available at design time.

Data Type

Boolean

UserDetailsPictureURL Property (OpenID Class)

This property holds the URL of the user's profile picture.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetUserDetailsPictureURL();

Unicode (Windows)
LPWSTR GetUserDetailsPictureURL();

char* ipworksauth_openid_getuserdetailspictureurl(void* lpObj);

QString GetUserDetailsPictureURL();

Default Value

""

Remarks

This property holds the URL of the user's profile picture.

This property is read-only and not available at design time.

Data Type

String

UserDetailsPreferredUsername Property (OpenID Class)

This property holds the shorthand name by which the end-user wishes to be referred.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetUserDetailsPreferredUsername();

Unicode (Windows)
LPWSTR GetUserDetailsPreferredUsername();

char* ipworksauth_openid_getuserdetailspreferredusername(void* lpObj);

QString GetUserDetailsPreferredUsername();

Default Value

""

Remarks

This property holds the shorthand name by which the end-user wishes to be referred.

This property is read-only and not available at design time.

Data Type

String

UserDetailsProfileURL Property (OpenID Class)

This property holds the URL of the user's profile page.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetUserDetailsProfileURL();

Unicode (Windows)
LPWSTR GetUserDetailsProfileURL();

char* ipworksauth_openid_getuserdetailsprofileurl(void* lpObj);

QString GetUserDetailsProfileURL();

Default Value

""

Remarks

This property holds the URL of the user's profile page.

This property is read-only and not available at design time.

Data Type

String

UserDetailsSubject Property (OpenID Class)

This property holds the subject identifier of the token.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetUserDetailsSubject();

Unicode (Windows)
LPWSTR GetUserDetailsSubject();

char* ipworksauth_openid_getuserdetailssubject(void* lpObj);

QString GetUserDetailsSubject();

Default Value

""

Remarks

This property holds the subject identifier of the token.

This property is read-only and not available at design time.

Data Type

String

UserDetailsTokenAuthTime Property (OpenID Class)

This property holds the time when authentication occurred.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetUserDetailsTokenAuthTime();

Unicode (Windows)
LONG64 GetUserDetailsTokenAuthTime();

int64 ipworksauth_openid_getuserdetailstokenauthtime(void* lpObj);

qint64 GetUserDetailsTokenAuthTime();

Default Value

0

Remarks

This property holds the time when authentication occurred.

The time value is a number representing the number of seconds from 1970-01-01T0:0:0Z as measured in UTC until the date/time.

This property is read-only and not available at design time.

Data Type

Long64

UserDetailsTokenExpTime Property (OpenID Class)

This property holds the expiration time of the token.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetUserDetailsTokenExpTime();

Unicode (Windows)
LONG64 GetUserDetailsTokenExpTime();

int64 ipworksauth_openid_getuserdetailstokenexptime(void* lpObj);

qint64 GetUserDetailsTokenExpTime();

Default Value

0

Remarks

This property holds the expiration time of the token.

The time value is a number representing the number of seconds from 1970-01-01T0:0:0Z as measured in UTC until the date/time.

This property is read-only and not available at design time.

Data Type

Long64

UserDetailsTokenIssuedAt Property (OpenID Class)

This property holds the time when the token was issued.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetUserDetailsTokenIssuedAt();

Unicode (Windows)
LONG64 GetUserDetailsTokenIssuedAt();

int64 ipworksauth_openid_getuserdetailstokenissuedat(void* lpObj);

qint64 GetUserDetailsTokenIssuedAt();

Default Value

0

Remarks

This property holds the time when the token was issued.

The time value is a number representing the number of seconds from 1970-01-01T0:0:0Z as measured in UTC until the date/time.

This property is read-only and not available at design time.

Data Type

Long64

UserDetailsUpdatedAt Property (OpenID Class)

This property holds the time when the user's information was last updated.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetUserDetailsUpdatedAt();

Unicode (Windows)
LONG64 GetUserDetailsUpdatedAt();

int64 ipworksauth_openid_getuserdetailsupdatedat(void* lpObj);

qint64 GetUserDetailsUpdatedAt();

Default Value

0

Remarks

This property holds the time when the user's information was last updated.

The time value is a number representing the number of seconds from 1970-01-01T0:0:0Z as measured in UTC until the date/time.

This property is read-only and not available at design time.

Data Type

Long64

UserDetailsWebsite Property (OpenID Class)

This property holds the URL of the user's website.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetUserDetailsWebsite();

Unicode (Windows)
LPWSTR GetUserDetailsWebsite();

char* ipworksauth_openid_getuserdetailswebsite(void* lpObj);

QString GetUserDetailsWebsite();

Default Value

""

Remarks

This property holds the URL of the user's website.

This property is read-only and not available at design time.

Data Type

String

UserDetailsZoneInfo Property (OpenID Class)

This property holds the user's time zone.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetUserDetailsZoneInfo();

Unicode (Windows)
LPWSTR GetUserDetailsZoneInfo();

char* ipworksauth_openid_getuserdetailszoneinfo(void* lpObj);

QString GetUserDetailsZoneInfo();

Default Value

""

Remarks

This property holds the user's time zone. For instance: America/Los_Angeles.

This property is read-only and not available at design time.

Data Type

String

WebServerPort Property (OpenID Class)

This property includes the local port on which the embedded web server listens.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetWebServerPort();
int SetWebServerPort(int iWebServerPort);

Unicode (Windows)
INT GetWebServerPort();
INT SetWebServerPort(INT iWebServerPort);

int ipworksauth_openid_getwebserverport(void* lpObj);
int ipworksauth_openid_setwebserverport(void* lpObj, int iWebServerPort);

int GetWebServerPort();
int SetWebServerPort(int iWebServerPort);

Default Value

0

Remarks

This property specifies the port on which the embedded web server listens. Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be returned when this setting is queried after the server has started listening. This is applicable only when using the embedded web server.

Data Type

Integer

WebServerSSLCertStore Property (OpenID Class)

This is the name of the certificate store for the client certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetWebServerSSLCertStore(char* &lpWebServerSSLCertStore, int &lenWebServerSSLCertStore);
int SetWebServerSSLCertStore(const char* lpWebServerSSLCertStore, int lenWebServerSSLCertStore);

Unicode (Windows)
INT GetWebServerSSLCertStore(LPSTR &lpWebServerSSLCertStore, INT &lenWebServerSSLCertStore);
INT SetWebServerSSLCertStore(LPCSTR lpWebServerSSLCertStore, INT lenWebServerSSLCertStore);

int ipworksauth_openid_getwebserversslcertstore(void* lpObj, char** lpWebServerSSLCertStore, int* lenWebServerSSLCertStore);
int ipworksauth_openid_setwebserversslcertstore(void* lpObj, const char* lpWebServerSSLCertStore, int lenWebServerSSLCertStore);

QByteArray GetWebServerSSLCertStore();
int SetWebServerSSLCertStore(QByteArray qbaWebServerSSLCertStore);

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The WebServerSSLCertStoreType property denotes the type of the certificate store specified by WebServerSSLCertStore. If the store is password protected, specify the password in WebServerSSLCertStorePassword.

WebServerSSLCertStore is used in conjunction with the WebServerSSLCertSubject property to specify client certificates. If WebServerSSLCertStore has a value, and WebServerSSLCertSubject or WebServerSSLCertEncoded is set, a search for a certificate is initiated. Please see the WebServerSSLCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Binary String

WebServerSSLCertStorePassword Property (OpenID Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetWebServerSSLCertStorePassword();
int SetWebServerSSLCertStorePassword(const char* lpszWebServerSSLCertStorePassword);

Unicode (Windows)
LPWSTR GetWebServerSSLCertStorePassword();
INT SetWebServerSSLCertStorePassword(LPCWSTR lpszWebServerSSLCertStorePassword);

char* ipworksauth_openid_getwebserversslcertstorepassword(void* lpObj);
int ipworksauth_openid_setwebserversslcertstorepassword(void* lpObj, const char* lpszWebServerSSLCertStorePassword);

QString GetWebServerSSLCertStorePassword();
int SetWebServerSSLCertStorePassword(QString qsWebServerSSLCertStorePassword);

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

WebServerSSLCertStoreType Property (OpenID Class)

This is the type of certificate store for this certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetWebServerSSLCertStoreType();
int SetWebServerSSLCertStoreType(int iWebServerSSLCertStoreType);

Unicode (Windows)
INT GetWebServerSSLCertStoreType();
INT SetWebServerSSLCertStoreType(INT iWebServerSSLCertStoreType);

CST_USER(0), 
CST_MACHINE(1), 
CST_PFXFILE(2), 
CST_PFXBLOB(3), 
CST_JKSFILE(4), 
CST_JKSBLOB(5), 
CST_PEMKEY_FILE(6), 
CST_PEMKEY_BLOB(7), 
CST_PUBLIC_KEY_FILE(8), 
CST_PUBLIC_KEY_BLOB(9), 
CST_SSHPUBLIC_KEY_BLOB(10), 
CST_P7BFILE(11), 
CST_P7BBLOB(12), 
CST_SSHPUBLIC_KEY_FILE(13), 
CST_PPKFILE(14), 
CST_PPKBLOB(15), 
CST_XMLFILE(16), 
CST_XMLBLOB(17), 
CST_JWKFILE(18), 
CST_JWKBLOB(19), 
CST_SECURITY_KEY(20), 
CST_BCFKSFILE(21), 
CST_BCFKSBLOB(22), 
CST_PKCS11(23), 
CST_AUTO(99)

int ipworksauth_openid_getwebserversslcertstoretype(void* lpObj);
int ipworksauth_openid_setwebserversslcertstoretype(void* lpObj, int iWebServerSSLCertStoreType);

int GetWebServerSSLCertStoreType();
int SetWebServerSSLCertStoreType(int iWebServerSSLCertStoreType);

Default Value

0

Remarks

This is the type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

Data Type

Integer

WebServerSSLCertSubject Property (OpenID Class)

This is the subject of the certificate used for client authentication.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetWebServerSSLCertSubject();
int SetWebServerSSLCertSubject(const char* lpszWebServerSSLCertSubject);

Unicode (Windows)
LPWSTR GetWebServerSSLCertSubject();
INT SetWebServerSSLCertSubject(LPCWSTR lpszWebServerSSLCertSubject);

char* ipworksauth_openid_getwebserversslcertsubject(void* lpObj);
int ipworksauth_openid_setwebserversslcertsubject(void* lpObj, const char* lpszWebServerSSLCertSubject);

QString GetWebServerSSLCertSubject();
int SetWebServerSSLCertSubject(QString qsWebServerSSLCertSubject);

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

WebServerSSLEnabled Property (OpenID Class)

This property specifies whether the web server requires Secure Sockets Layer (SSL) connections.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetWebServerSSLEnabled();
int SetWebServerSSLEnabled(int bWebServerSSLEnabled);

Unicode (Windows)
BOOL GetWebServerSSLEnabled();
INT SetWebServerSSLEnabled(BOOL bWebServerSSLEnabled);

int ipworksauth_openid_getwebserversslenabled(void* lpObj);
int ipworksauth_openid_setwebserversslenabled(void* lpObj, int bWebServerSSLEnabled);

bool GetWebServerSSLEnabled();
int SetWebServerSSLEnabled(bool bWebServerSSLEnabled);

Default Value

FALSE

Remarks

This setting specifies whether the embedded web server uses a Secure Sockets Layer (SSL). If set to True, WebServerSSLCert is required and the server will accept only SSL connections. If set to False, only plaintext connects are supported.

Data Type

Boolean

AddCookie Method (OpenID Class)

This method adds a cookie and the corresponding value to the outgoing request headers.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int AddCookie(const char* lpszCookieName, const char* lpszCookieValue);

Unicode (Windows)
INT AddCookie(LPCWSTR lpszCookieName, LPCWSTR lpszCookieValue);

int ipworksauth_openid_addcookie(void* lpObj, const char* lpszCookieName, const char* lpszCookieValue);

int AddCookie(const QString& qsCookieName, const QString& qsCookieValue);

Remarks

This property adds a cookie and the corresponding value to the outgoing request headers. Please refer to the Cookies property for more information on cookies and how they are managed.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

AddParam Method (OpenID Class)

This method adds a name-value pair to the query string parameters of outgoing request.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int AddParam(const char* lpszParamName, const char* lpszParamValue);

Unicode (Windows)
INT AddParam(LPCWSTR lpszParamName, LPCWSTR lpszParamValue);

int ipworksauth_openid_addparam(void* lpObj, const char* lpszParamName, const char* lpszParamValue);

int AddParam(const QString& qsParamName, const QString& qsParamValue);

Remarks

This method can be used to add query string parameters to the outgoing request. One common use for this method would be to add the state parameter to the request, which can be used when the ClientProfile is ocpWeb to add user-defined data. The authorization server will include the state parameter in the response and will be available in the post back to your server, which will allow you to maintain state in your application.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Config Method (OpenID Class)

Sets or retrieves a configuration setting.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* ipworksauth_openid_config(void* lpObj, const char* lpszConfigurationString);

QString Config(const QString& qsConfigurationString);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

DoEvents Method (OpenID Class)

Processes events from the internal message queue.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DoEvents();

Unicode (Windows)
INT DoEvents();

int ipworksauth_openid_doevents(void* lpObj);

int DoEvents();

Remarks

When DoEvents is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

GetAuthorization Method (OpenID Class)

Gets the authorization string required to access the protected resource.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAuthorization();

Unicode (Windows)
LPWSTR GetAuthorization();

char* ipworksauth_openid_getauthorization(void* lpObj);

QString GetAuthorization();

Remarks

GetAuthorization performs several operations automatically depending on the value of ClientProfile. Please see the introduction section for the OpenID class for a detailed overview of the typical scenarios.

After authorization is complete, UserDetails will be populated with the claims parsed from the ID token. This method also returns an authorization string. The authorization string grants access to additional resources as requested via the AuthorizationScope property. If access to another resource was requested, then the access token returned here may be set in the Authorization property of any other class (or passed as the value of the HTTP Authorization header).

GetUserInfo may be called after calling this method.

The following properties are applicable when calling this method:

• ClientId (required)
• ClientSecret (required)
• ServerAuthURL (required - populated by GetDiscoveryDoc.)
• ServerTokenURL (required - populated by GetDiscoveryDoc.)
• SignerCertURL (conditional - populated by GetDiscoveryDoc. Required if SignerCert is not set.)
• SignerCert (conditional - required if SignerCertURL is not set.)
• AuthorizationScope
• ClientProfile
• GrantType
• Params
• RefreshToken
• ReturnURL
• State
• Timeout
• Display
• Prompt
• IDTokenHint
• LoginHint
• ResponseType

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

GetAuthorizationURL Method (OpenID Class)

This method builds and returns the URL to which the user should be redirected for authorization.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAuthorizationURL();

Unicode (Windows)
LPWSTR GetAuthorizationURL();

char* ipworksauth_openid_getauthorizationurl(void* lpObj);

QString GetAuthorizationURL();

Remarks

When this method is called, the class will return the URL used for authorization. The class will not make any connections, but instead it will return the URL to you so that you may redirect the user to this location. This is useful when ClientProfile is set to ocpWeb. Before calling this method, set the following:

• ClientId
• ClientSecret
• ReturnURL
• AuthorizationScope (optional)

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

GetDiscoveryDoc Method (OpenID Class)

Gets the OpenID Discovery Document.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetDiscoveryDoc(const char* lpszURL);

Unicode (Windows)
INT GetDiscoveryDoc(LPCWSTR lpszURL);