OIDCDesktop Class

Properties   Methods   Events   Config Settings   Errors  

The OIDCDesktop class provides an easy way to add OpenID Connect-based SSO to your desktop application.

Class Name

CloudSSO_OIDCDesktop

Procedural Interface

 cloudsso_oidcdesktop_open();
 cloudsso_oidcdesktop_close($res);
 cloudsso_oidcdesktop_register_callback($res, $id, $function);
 cloudsso_oidcdesktop_get_last_error($res);
 cloudsso_oidcdesktop_get_last_error_code($res);
 cloudsso_oidcdesktop_set($res, $id, $index, $value);
 cloudsso_oidcdesktop_get($res, $id, $index);
 cloudsso_oidcdesktop_do_addparam($res, $paramname, $paramvalue);
 cloudsso_oidcdesktop_do_authenticateuser($res);
 cloudsso_oidcdesktop_do_config($res, $configurationstring);
 cloudsso_oidcdesktop_do_doevents($res);
 cloudsso_oidcdesktop_do_getdiscoverymetadata($res, $metadataname);
 cloudsso_oidcdesktop_do_getidtokenclaim($res, $claimname);
 cloudsso_oidcdesktop_do_getqueryparam($res, $paramname);
 cloudsso_oidcdesktop_do_getuserinfoclaim($res, $claimname);
 cloudsso_oidcdesktop_do_interrupt($res);
 cloudsso_oidcdesktop_do_loaddiscoverydoc($res, $documentdata);
 cloudsso_oidcdesktop_do_loadsignerjwks($res, $jwksdata);
 cloudsso_oidcdesktop_do_parseidtoken($res);
 cloudsso_oidcdesktop_do_requestdiscoverydoc($res, $url);
 cloudsso_oidcdesktop_do_requestsignercerts($res);
 cloudsso_oidcdesktop_do_requestuserinfo($res);
 cloudsso_oidcdesktop_do_reset($res);
 cloudsso_oidcdesktop_do_startwebserver($res);
 cloudsso_oidcdesktop_do_stopwebserver($res);
 cloudsso_oidcdesktop_do_validateidtoken($res);

Remarks

The OIDCDesktop class provides a simple way to authenticate users using OpenID Connect. The library makes it easy to add SSO support to desktop applications. Identity management is performed by OpenID Providers such as Microsoft, Google, Apple, GitHub, GitLab, Okta, or others.

OpenID Connect is an extension of the OAuth 2.0 specification that adds user authentication (ID Tokens) along with the authorization received by the OAuth provider (access tokens). In OpenID Connect, the OpenID Provider is the third-party service that will handle the actual authentication of the user. In OAuth 2.0, this would be similar to authorization server. On the other side, the application that want authentication is called a Relying Party. In OAuth 2.0, this would be similar to the OAuth client. Like in OAuth, when the application needs to authenticate a user, they will need to redirect the user to the OpenID Provider's authorization server. The authorization server will authenticate the user, get authorization from the user to allow the application access to their profile, then get redirect back to the application's web server for further processing.

For ease-of-use, the class will handle launching a web server for your application, removing the need for your application to parse the response from the authorization server and correctly parsing and validating the response. In accordance with recommendations for desktop applications from the OAuth 2.0 specification and the OpenID Connect standard, the web server is hosted on a localhost instance.

Once the redirect has been processed, the application typically make an additional request to the OpenID Provider's token server for an ID Token, access token, and refresh token.

--- TBD ---

Setup

Typically, the Relying Party will need to register their application with the OpenID Provider. This will give the OpenID Provider knowledge about the Relying Party. The exact information needed depends on the OpenID Provider that is being used, but typically this will include the redirect_uri to which users will be returned after authentication has been completed. Once registered, the OpenID Provider will also provide the Relying Party with some information. Typically the following values will be provided by the OpenID Provider:

• Client Id (Required)
• Client Secret (Optional)
• Discovery Document URL (Recommended)

Once the application has been registered, the Relying Party can begin authenticating users.

Discovery

To start, a Relying Party will need to get information about the OpenID Provider they are connecting to. OIDC uses discovery documents to provide information about an OpenID Provider to a Relying Party. The OpenID Provider should host their discovery document at the domain of the issuer with /.well-known/openid-configuration concatenated at the end. For example, if the issuer is https://example.com, the discovery document URL would be:

https://example.com/.well-known/openid-configuration

This document stores important information that is required to correctly make requests and validate responses from an OpenID Provider.

Usage: Getting the Discovery Document

The OIDC class simplifies requesting and parsing the discovery document. The RequestDiscoveryDoc method will make a request to the specified discovery document URL. It will retrieve the discovery document and parse the commonly used information from it, setting the properties in the DiscoveryDocDetails property. For example:

oidc.RequestDiscoveryDoc("https://example.com/.well-known/openid-configuration"); string issuer = oidc.DiscoveryDocDetails.Issuer;

This discovery document does change from time to time, but typically it can be cached to reduce the number of requests being made by the Relying Party. To save the discovery document for later, the DiscoveryDocDetailsContent property can be queried to get the raw JSON document. When the discovery document needs to be reloaded, the LoadDiscoveryDoc method can be used to reload the document. For example:

oidc.RequestDiscoveryDoc("https://example.com/.well-known/openid-configuration"); string raw_document = oidc.DiscoveryDocDetails.Content; //Save raw_document for later oidc.LoadDiscoveryDoc(raw_document);

The following properties and methods handle requesting, loading, or parsing discovery documents:

• DiscoveryDocDetails
• GetDiscoveryMetadata
• LoadDiscoveryDoc
• RequestDiscoveryDoc

Signing Certificates

The discovery document also provides a URI for the JSON Web Key Set (JWKS) that will be used to verify ID Tokens (see below). Each JSON Web Key Set contains one or more public certificates (keys) that correspond to a private key that can be used when an OpenID provider signs an ID Token. These keys are often rotated periodically but can generally be cached to reduce the amount of requests being made by the Relying Party.

Usage: Requesting and Reloading Signing Certificates

The RequestSignerCerts method can be used to request the JWKS directly from the JWKS URI. This method will set the SignerJWKS property which is automatically parsed to fill the SignerCerts properties. If the SignerCerts properties is empty and the class needs to verify the ID Token, the class will automatically make this request.

To reduce the number of requests made by the Relying Party, the LoadSignerJWKS method can be used to parse the SignerJWKS again. This allows the Relying Party to cache the SignerJWKS property and reuse it later, reducing the amount of times the JWKS is requested from the OpenID Provider. oidc.RequestDiscoveryDoc("https://example.com/.well-known/openid-configuration"); oidc.RequestSignerCerts(); string raw_jwks = oidc.SignerJWKS; //Save or Cache for later. //Continue on with operations that need to verify an ID Token. //Sometime later with a new instance. oidc.SignerJWKS = raw_jwks; oidc.LoadSignerJWKS(); //Continue on with new operations that need to verify an ID Token.

Authentication

The exact flow that a Relying Party goes through to authenticate a user depends on how the Relying Party configures their requests. These flows are broken up into different Grant Types with the most common being the Authorization Code grant type.

For a Relying Party using the Authorization Code grant type, the user must be redirected to the OpenID Provider's Authorization URL. The OpenID Provider will first ask the user to authenticate themselves. Once the user is authenticated, the OpenID Provider will then request authorization from the user to allow the Relying Party to access specific information about their account. This information will then be used to authenticate the user to the Relying Party. Once authorization has been provided, the user will be redirected back to the Relying Party with an authorization code.

With the authorization code, the Relying Party can now make a request to the token URL. The token server requires the authorization_code, client_id, and optional client_secret to confirm that the Relying Party has obtained authorization from the authorization server. The token server will then return an access_token,id_token, and optional refresh_token. To finish authenticating the user to the web application, the Relying Party will then validate the ID Token (see below).

Getting Authorization

To get authorization from an OpenID Provider, the user will need to be directed to the authorization server using an Authorization URL. There, the user will be asked to login and give authorization for (or consent to) the OpenID provider giving access to the specified information within the scope set by the Relying Party.

Usage: Getting the Authorization URL

The following example will assume that the Relying Party is using the ogtAuthorizationCode GrantType. This grant type sets the ResponseType to code, instructing the OpenID Provider to send the authorization code once authorization has been completed. First, the OIDC class needs to be configured with the information about the OpenID Provider (see Discovery above) and the specific information that has been provided or configured about the Relying Party. Once the class is configured, the GetAuthorizationURL method can be used to get the URL to which the user should be directed in order to complete the authorization process. //OpenID Provider oidc.RequestDiscoveryDoc("https://example.com/.well-known/openid-configuration"); //Relying Party oidc.GrantType = ogtAuthorizationCode; oidc.ClientId = "Relying Party ID"; oidc.ReturnURL = "https://relying_party.com/"; oidc.AuthorizationScope = "openid profile email"; string authorization_url = oidc.GetAuthorizationURL(); //Direct the user to the URL...

Authorization Response

Once the authorization process has been completed, the OpenID Provider will redirect the user back to the Relying Party. Depending on the response_type set by the Relying Party, the redirect may contain any combination of an ID Token, an access token, or an authorization code. Once the user has been redirected back to the Relying Party, the request must be parsed to obtain the information from the OpenID Provider.

Parse vs. Process

The ParseOIDCResponse and ProcessOIDCResponse methods are used to handle HTTP requests that contain an OIDC response from an OpenID Provider. Generally, unless additional considerations or control are needed, the ProcessOIDCResponse method should be used. ProcessOIDCResponse will parse the incoming response from the OpenID Provider and make any additional requests necessary to obtain the access tokens and ID Tokens, as well as perform any necessary validation. For example, if an authorization code is found in the request, it will automatically make a request to the token server and handle/validate the response.

The ParseOIDCResponse method will only parse the information from the request. If an ID Token is found in the request, it will be validated. No further actions are performed.

Usage: Handling a redirect from an OpenID Provider

The OIDC class provides the ParseOIDCResponse and ProcessOIDCResponse methods to make it simple to get the required information from a redirect.

If the current HTTP context is unavailable, for instance when the class is not used directly within a web application, the HTTP headers and body that contain the OIDC response can be supplied by setting the OIDCResponseHeaders and OIDCResponseBody properties.

The rest of the examples in this section will assume that the ParseOIDCResponse method is being used. See the ProcessOIDCResponse method for more information.

Getting Tokens

Once the Relying Party has an authorization code, the code can be used to obtain an ID Token and access token from the token server. Like when building the Authorization URL, the class will need to be configured again. Along with the other information, this step sometimes requires that a client secret be provided if it can be stored securely.

When RequestTokens is called, a request is made to the token server. The token server authenticates the requester (the Relying Party) using the information provided in the request. Then, the token server will return an access token, an ID Token, and an optional refresh token. The Relying Party then needs to verify the ID Token (see below).

Refresh Tokens

Refresh tokens allow Relying Parties to skip obtaining authorization again for users that have already provided it once. How refresh tokens work depends on the OpenID Provider, but when the RefreshToken property is set before calling RequestTokens, the request will be made without the authorization code and the RefreshToken will be used instead.

Usage: Request Tokens

The RequestTokens method is used in the following example to make a request to the token server after ParseOIDCResponse has been called. //Parse OIDC Response oidc.ParseOIDCResponse(); //Get OpenID Provider Settings oidc.RequestDiscoveryDoc("https://example.com/.well-known/openid-configuration"); //Relying Party Settings oidc.GrantType = ogtAuthorizationCode; oidc.ClientId = "Relying Party ID"; oidc.ClientSecret = "Relying Party Secret Value"; oidc.ReturnURL = "https://relying_party.com/"; oidc.AuthorizationScope = "openid profile email"; try { oidc.RequestTokens(); } catch (OIDCException e) { //Error handling if there is an issue with the response. } string access_token = oidc.AccessToken; string id_token = oidc.IdTokenInfo.IdTokenContent; string refresh_token = oidc.RefreshToken;

Verifying ID Tokens

When a Relying Party receives an ID Token, it can verify the token to confirm the identity of the user that it represents. When the class receives an ID Token after calling ParseOIDCResponse, ProcessOIDCResponse, or RequestTokens, it will automatically validate the ID Token.

The validation process checks the different JWT claims in the ID Token along with the signature using one of the keys from the JWKS provided by the OpenID Provider (see Signing Certificates). The following claims are used to validate the ID Token:

Usage: Validate and Parse an ID Token

In a case where an ID Token is provided directly to the class, the ValidateIdToken method can be used to validate it, and the ParseIdToken method can be used to parse it. The following example will set up the class with the information needed to validate and parse the ID Token. //OpenID Provider oidc.RequestDiscoveryDoc("https://example.com/.well-known/openid-configuration"); oidc.RequestSignerCerts(); //Relying Party oidc.ClientId = "Relying Party ID"; oidc.IdTokenInfo.IdTokenContent = "ID_TOKEN"; try { oidc.ValidateIdToken(); } catch (OIDCException e) { //If there is any validation issues. } //Parse the validated ID Token. oidc.ParseIdToken(); string issuer = oidc.IdTokenInfo.Issuer;

User Information

OpenID Providers give information about users through claims. These claims can be found in an ID Token or by calling the UserInfo endpoint to request the information directly.

When commonly used claims are parsed from an ID Token or the response from the UserInfo endpoint, the class will set the properties in the UserDetails property with the corresponding information. If there is a claim that is not found in the UserDetails property, the GetIdTokenClaim and the GetUserInfoClaim methods can be used to search for specific claims.

Usage: Request UserInfo

To make a request to the UserInfo endpoint, the class will need to have the AccessToken property set. Additionally, the discovery document can be used to get the UserInfo endpoint. The following code example assumes that the AccessToken has been set to a cached token from the current user session. oidc.RequestDiscoveryDoc("https://example.com/.well-known/openid-configuration"); oidc.AccessToken = "ACCESS_TOKEN"; oidc.RequestUserInfo(); string email = oidc.UserDetails.Email; string custom_claim = oidc.GetUserInfoClaim("/json/custom_claim");

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 (CloudSSO_OIDCDesktop Class)

The access token received from an OpenID provider.

Object Oriented Interface

public function getAccessToken();
public function setAccessToken($value);

Procedural Interface

cloudsso_oidcdesktop_get($res, 1 );
cloudsso_oidcdesktop_set($res, 1, $value );

Default Value

''

Remarks

This property will be populated with an access token that was received from an OpenID provider. When set, the AccessTokenExp configuration setting will also be set with the expiration date of the access token. The access token allows for requests to be made to the DiscoveryDocDetailsUserInfoURL to retrieve information about the authenticated user. Additionally, depending on the OpenID provider, it may be used to access other APIs that are supported by the OpenID provider depending on how AuthorizationScope was set when calling AuthenticateUser.

Each AccessToken is specific to the user that authorized the OpenID provider to provide it to your application. An AccessToken cannot be shared between multiple users.

When an OpenID provider provides an access token depends on the ResponseType that was set when calling AuthenticateUser. Typically, the ResponseType configuration setting is set when selecting a GrantType which is set to ogtAuthorizationCode by default.When ResponseType contains code (ogtAuthorizationCode and ogtHybrid), the AccessToken is provided by the DiscoveryDocDetailsTokenURL by making a request to the token server. When ResponseType contains token (ogtImplicit and ogtHybrid), the AccessToken is provided by the DiscoveryDocDetailsAuthorizationURL in the authorization response.

Data Type

String

AuthorizationScope Property (CloudSSO_OIDCDesktop Class)

The authorization scope used during authorization.

Object Oriented Interface

public function getAuthorizationScope();
public function setAuthorizationScope($value);

Procedural Interface

cloudsso_oidcdesktop_get($res, 2 );
cloudsso_oidcdesktop_set($res, 2, $value );

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 must always be present. The default value is openid.

After calling AuthenticateUser, if the authorization server returned the scope parameter, this property will be updated to match.

Along with OpenID Connect scopes, some OpenID providers also support other OAuth 2.0 scopes for various APIs that are also hosted by the OpenID provider. These can often also be added alongside the OpenID scopes. For example, openid profile email offline_access Mail.ReadWrite would be an example of a valid AuthorizationScope when using Microsoft Entra as an OpenID provider.

See the OpenID provider's documentation for supported values.

Data Type

String

AuthzResponseCode Property (CloudSSO_OIDCDesktop Class)

The error code from a recent authorization attempt.

Object Oriented Interface

public function getAuthzResponseCode();

Procedural Interface

cloudsso_oidcdesktop_get($res, 3 );

Default Value

''

Remarks

This property holds the most recent error response code from the most recent response to an authorization (Authz) attempt. This is set when AuthenticateUser is called and the error response parameter is present in the authorization response. A description (if provided) of the error code can be found in the AuthzResponseDesc property. The AuthErrorURI configuration setting may also be set if the request provided a URL to a page that describes the error.

This property is read-only.

Data Type

String

AuthzResponseDesc Property (CloudSSO_OIDCDesktop Class)

The error description from a recent authorization attempt.

Object Oriented Interface

public function getAuthzResponseDesc();

Procedural Interface

cloudsso_oidcdesktop_get($res, 4 );

Default Value

''

Remarks

This property holds the most recent error response description from the most recent response to an authorization (Authz) attempt. This is set when AuthenticateUser is called and the error_description response parameter is present in the authorization response. The code for this error can be found in the AuthzResponseCode property.

This property is read-only.

Data Type

String

ClientId Property (CloudSSO_OIDCDesktop Class)

The Id of the client assigned when registering the application.

Object Oriented Interface

public function getClientId();
public function setClientId($value);

Procedural Interface

cloudsso_oidcdesktop_get($res, 5 );
cloudsso_oidcdesktop_set($res, 5, $value );

Default Value

''

Remarks

This property holds the Id of the relying party, also known as the client application, that was assigned when initially registering the application with the OpenID provider. This is also sometimes referred to as the application id or the relying party id. This property is used to build an make the requests made to the authorization and token servers when calling AuthenticateUser method. Additionally, it is used to verify the IdTokenAudiences property of an ID Token when calling the AuthenticateUser or ValidateIdToken methods.

Data Type

String

ClientSecret Property (CloudSSO_OIDCDesktop Class)

The secret value for the client assigned when registering the application.

Object Oriented Interface

public function getClientSecret();
public function setClientSecret($value);

Procedural Interface

cloudsso_oidcdesktop_get($res, 6 );
cloudsso_oidcdesktop_set($res, 6, $value );

Default Value

''

Remarks

This property holds the secret of the client that might have been assigned when initially registering the application with the OpenID provider. This property is optional depending on the OpenID provider. If provided, it will be used when making a request to the token server when calling AuthenticateUser.

Data Type

String

DiscoveryDocDetailsAuthorizationURL Property (CloudSSO_OIDCDesktop Class)

The server authorization endpoint URL.

Object Oriented Interface

public function getDiscoveryDocDetailsAuthorizationURL();

Procedural Interface

cloudsso_oidcdesktop_get($res, 7 );

Default Value

''

Remarks

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 (CloudSSO_OIDCDesktop Class)

Whether the claims request parameter is supported by the Open ID provider.

Object Oriented Interface

public function getDiscoveryDocDetailsClaimsParamSupported();

Procedural Interface

cloudsso_oidcdesktop_get($res, 8 );

Default Value

false

Remarks

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

DiscoveryDocDetailsContent Property (CloudSSO_OIDCDesktop Class)

The raw discovery document JSON.

Object Oriented Interface

public function getDiscoveryDocDetailsContent();

Procedural Interface

cloudsso_oidcdesktop_get($res, 9 );

Default Value

''

Remarks

The raw discovery document JSON.

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

Data Type

String

DiscoveryDocDetailsIssuer Property (CloudSSO_OIDCDesktop Class)

The issuer identifier of the OpenID provider.

Object Oriented Interface

public function getDiscoveryDocDetailsIssuer();

Procedural Interface

cloudsso_oidcdesktop_get($res, 10 );

Default Value

''

Remarks

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

DiscoveryDocDetailsLogoutURL Property (CloudSSO_OIDCDesktop Class)

The logout endpoint URL.

Object Oriented Interface

public function getDiscoveryDocDetailsLogoutURL();

Procedural Interface

cloudsso_oidcdesktop_get($res, 11 );

Default Value

''

Remarks

The logout endpoint URL.

This setting corresponds to the optional end_session_endpoint parameter that may be found in the discovery document. If a user is directed to this URL, they will be asked to log out of their account.

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

Data Type

String

DiscoveryDocDetailsRegistrationURL Property (CloudSSO_OIDCDesktop Class)

The dynamic client registration URL.

Object Oriented Interface

public function getDiscoveryDocDetailsRegistrationURL();

Procedural Interface

cloudsso_oidcdesktop_get($res, 12 );

Default Value

''

Remarks

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 (CloudSSO_OIDCDesktop Class)

The URL of the human-readable service documentation.

Object Oriented Interface

public function getDiscoveryDocDetailsServiceDocsURL();

Procedural Interface

cloudsso_oidcdesktop_get($res, 13 );

Default Value

''

Remarks

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 (CloudSSO_OIDCDesktop Class)

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

Object Oriented Interface

public function getDiscoveryDocDetailsSignerCertURL();

Procedural Interface

cloudsso_oidcdesktop_get($res, 14 );

Default Value

''

Remarks

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 (CloudSSO_OIDCDesktop Class)

A comma-separated list of claims that are supported by the OpenID provider.

Object Oriented Interface

public function getDiscoveryDocDetailsSupportedClaims();

Procedural Interface

cloudsso_oidcdesktop_get($res, 15 );

Default Value

''

Remarks

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 (CloudSSO_OIDCDesktop Class)

A comma-separated list of display values that are supported by the OpenID provider.

Object Oriented Interface

public function getDiscoveryDocDetailsSupportedDisplays();

Procedural Interface

cloudsso_oidcdesktop_get($res, 16 );

Default Value

''

Remarks

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 (CloudSSO_OIDCDesktop Class)

A comma-separated list of grant types supported by the OpenID provider.

Object Oriented Interface

public function getDiscoveryDocDetailsSupportedGrantTypes();

Procedural Interface

cloudsso_oidcdesktop_get($res, 17 );

Default Value

''

Remarks

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 (CloudSSO_OIDCDesktop Class)

A comma-separated list of response types supported by the OpenID provider.

Object Oriented Interface

public function getDiscoveryDocDetailsSupportedResponseTypes();

Procedural Interface

cloudsso_oidcdesktop_get($res, 18 );

Default Value

''

Remarks

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) the 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 (CloudSSO_OIDCDesktop Class)

A comma-separated list of scopes that are supported by the OpenID provider.

Object Oriented Interface

public function getDiscoveryDocDetailsSupportedScopes();

Procedural Interface

cloudsso_oidcdesktop_get($res, 19 );

Default Value

''

Remarks

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 (CloudSSO_OIDCDesktop Class)

The token endpoint URL.

Object Oriented Interface

public function getDiscoveryDocDetailsTokenURL();

Procedural Interface

cloudsso_oidcdesktop_get($res, 20 );

Default Value

''

Remarks

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 (CloudSSO_OIDCDesktop Class)

The user info endpoint URL.

Object Oriented Interface

public function getDiscoveryDocDetailsUserInfoURL();

Procedural Interface

cloudsso_oidcdesktop_get($res, 21 );

Default Value

''

Remarks

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 (CloudSSO_OIDCDesktop Class)

Whether to automatically detect and use firewall system settings, if available.

Object Oriented Interface

public function getFirewallAutoDetect();
public function setFirewallAutoDetect($value);

Procedural Interface

cloudsso_oidcdesktop_get($res, 22 );
cloudsso_oidcdesktop_set($res, 22, $value );

Default Value

false

Remarks

Whether to automatically detect and use firewall system settings, if available.

Data Type

Boolean

FirewallType Property (CloudSSO_OIDCDesktop Class)

The type of firewall to connect through.

Object Oriented Interface

public function getFirewallType();
public function setFirewallType($value);

Procedural Interface

cloudsso_oidcdesktop_get($res, 23 );
cloudsso_oidcdesktop_set($res, 23, $value );

Default Value

0

Remarks

The type of firewall to connect through. The applicable values are as follows:

Data Type

Integer

FirewallHost Property (CloudSSO_OIDCDesktop Class)

The name or IP address of the firewall (optional).

Object Oriented Interface

public function getFirewallHost();
public function setFirewallHost($value);

Procedural Interface

cloudsso_oidcdesktop_get($res, 24 );
cloudsso_oidcdesktop_set($res, 24, $value );

Default Value

''

Remarks

The name or IP address of the 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 (CloudSSO_OIDCDesktop Class)

A password if authentication is to be used when connecting through the firewall.

Object Oriented Interface

public function getFirewallPassword();
public function setFirewallPassword($value);

Procedural Interface

cloudsso_oidcdesktop_get($res, 25 );
cloudsso_oidcdesktop_set($res, 25, $value );

Default Value

''

Remarks

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 (CloudSSO_OIDCDesktop Class)

The Transmission Control Protocol (TCP) port for the firewall Host .

Object Oriented Interface

public function getFirewallPort();
public function setFirewallPort($value);

Procedural Interface

cloudsso_oidcdesktop_get($res, 26 );
cloudsso_oidcdesktop_set($res, 26, $value );

Default Value

0

Remarks

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 (CloudSSO_OIDCDesktop Class)

A username if authentication is to be used when connecting through a firewall.

Object Oriented Interface

public function getFirewallUser();
public function setFirewallUser($value);

Procedural Interface

cloudsso_oidcdesktop_get($res, 27 );
cloudsso_oidcdesktop_set($res, 27, $value );

Default Value

''

Remarks

A username if authentication is to be used when connecting through a firewall. If FirewallHost is specified, this property and the FirewallPassword property 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 (CloudSSO_OIDCDesktop Class)

Determines what happens when the server issues a redirect.

Object Oriented Interface

public function getFollowRedirects();
public function setFollowRedirects($value);

Procedural Interface

cloudsso_oidcdesktop_get($res, 28 );
cloudsso_oidcdesktop_set($res, 28, $value );

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 (CloudSSO_OIDCDesktop Class)

The grant type defining the authentication flow.

Object Oriented Interface

public function getGrantType();
public function setGrantType($value);

Procedural Interface

cloudsso_oidcdesktop_get($res, 29 );
cloudsso_oidcdesktop_set($res, 29, $value );

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:

• ogtAuthorizationCode (0)
• ogtImplicit (1)
• ogtHybrid (2)

When using the AuthenticateUser method, each grant type causes the authorization server to respond differently.

When using ogtAuthorizationCode (Authorization Code Flow - Default), the authorization server returns a code parameter containing the authorization code which is set to the AuthorizationCode setting. The method will then automatically exchange the authorization code for the ID Token, access token, and refresh tokens with the token server.

When using ogtImplicit (Implicit Flow), the authorization server returns the token and id_token parameters. This provides the access token and ID token directly to the web server. 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 ogtHybrid (Hybrid Flow), the authorization server returns the code and id_token parameters. This flow is a combination of the authorization code and implicit grant types. Like the implicit grant type, the class will validate the ID Token immediately, then it will exchange the authorization code with the token server receiving an access token and possible ID 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

IdTokenAudiences Property (CloudSSO_OIDCDesktop Class)

A comma-separated list of audiences for which the ID Token is intended.

Object Oriented Interface

public function getIdTokenAudiences();

Procedural Interface

cloudsso_oidcdesktop_get($res, 30 );

Default Value

''

Remarks

A comma-separated list of audiences for which the ID Token is intended.

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

Data Type

String

IdTokenAuthTime Property (CloudSSO_OIDCDesktop Class)

The time when the end user authenticates with the authorization server.

Object Oriented Interface

public function getIdTokenAuthTime();

Procedural Interface

cloudsso_oidcdesktop_get($res, 31 );

Default Value

0

Remarks

The time when the end user authenticates with the authorization server.

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

IdTokenExpTime Property (CloudSSO_OIDCDesktop Class)

The time when the ID Token expires.

Object Oriented Interface

public function getIdTokenExpTime();

Procedural Interface

cloudsso_oidcdesktop_get($res, 32 );

Default Value

0

Remarks

The time when the ID Token expires.

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

IdTokenIdTokenContent Property (CloudSSO_OIDCDesktop Class)

The raw value of the ID Token.

Object Oriented Interface

public function getIdTokenIdTokenContent();
public function setIdTokenIdTokenContent($value);

Procedural Interface

cloudsso_oidcdesktop_get($res, 33 );
cloudsso_oidcdesktop_set($res, 33, $value );

Default Value

''

Remarks

The raw value of the ID Token.

This property is not available at design time.

Data Type

String

IdTokenIssuedTime Property (CloudSSO_OIDCDesktop Class)

The time when the authentication for this ID Token occurred.

Object Oriented Interface

public function getIdTokenIssuedTime();

Procedural Interface

cloudsso_oidcdesktop_get($res, 34 );

Default Value

0

Remarks

The time when the authentication for this ID Token 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

IdTokenIssuer Property (CloudSSO_OIDCDesktop Class)

The issuer, or authorization server, that constructed the ID Token.

Object Oriented Interface

public function getIdTokenIssuer();

Procedural Interface

cloudsso_oidcdesktop_get($res, 35 );

Default Value

''

Remarks

The issuer, or authorization server, that constructed the ID Token.

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

Data Type

String

OtherHeaders Property (CloudSSO_OIDCDesktop Class)

Other headers as determined by the user (optional).

Object Oriented Interface

public function getOtherHeaders();
public function setOtherHeaders($value);

Procedural Interface

cloudsso_oidcdesktop_get($res, 36 );
cloudsso_oidcdesktop_set($res, 36, $value );

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 (CloudSSO_OIDCDesktop Class)

The number of records in the Param arrays.

Object Oriented Interface

public function getParamCount();
public function setParamCount($value);

Procedural Interface

cloudsso_oidcdesktop_get($res, 37 );
cloudsso_oidcdesktop_set($res, 37, $value );

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 (CloudSSO_OIDCDesktop Class)

The name of the parameter to be used in the request or returned in the response.

Object Oriented Interface

public function getParamName($paramindex);
public function setParamName($paramindex, $value);

Procedural Interface

cloudsso_oidcdesktop_get($res, 38 , $paramindex);
cloudsso_oidcdesktop_set($res, 38, $value , $paramindex);

Default Value

''

Remarks

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 (CloudSSO_OIDCDesktop Class)

The value of the parameter to be used in the request or returned in the response.

Object Oriented Interface

public function getParamValue($paramindex);
public function setParamValue($paramindex, $value);

Procedural Interface

cloudsso_oidcdesktop_get($res, 39 , $paramindex);
cloudsso_oidcdesktop_set($res, 39, $value , $paramindex);

Default Value

''

Remarks

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 (CloudSSO_OIDCDesktop Class)

The type of authorization to perform when connecting to the proxy.

Object Oriented Interface

public function getProxyAuthScheme();
public function setProxyAuthScheme($value);

Procedural Interface

cloudsso_oidcdesktop_get($res, 40 );
cloudsso_oidcdesktop_set($res, 40, $value );

Default Value

0

Remarks

The 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 class 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 (CloudSSO_OIDCDesktop Class)

Whether to automatically detect and use proxy system settings, if available.

Object Oriented Interface

public function getProxyAutoDetect();
public function setProxyAutoDetect($value);

Procedural Interface

cloudsso_oidcdesktop_get($res, 41 );
cloudsso_oidcdesktop_set($res, 41, $value );

Default Value

false

Remarks

Whether to automatically detect and use proxy system settings, if available. The default value is false.

Data Type

Boolean

ProxyPassword Property (CloudSSO_OIDCDesktop Class)

A password if authentication is to be used for the proxy.

Object Oriented Interface

public function getProxyPassword();
public function setProxyPassword($value);

Procedural Interface

cloudsso_oidcdesktop_get($res, 42 );
cloudsso_oidcdesktop_set($res, 42, $value );

Default Value

''

Remarks

A password 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

ProxyPort Property (CloudSSO_OIDCDesktop Class)

The Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Object Oriented Interface

public function getProxyPort();
public function setProxyPort($value);

Procedural Interface

cloudsso_oidcdesktop_get($res, 43 );
cloudsso_oidcdesktop_set($res, 43, $value );

Default Value

80

Remarks

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 (CloudSSO_OIDCDesktop Class)

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

Object Oriented Interface

public function getProxyServer();
public function setProxyServer($value);

Procedural Interface

cloudsso_oidcdesktop_get($res, 44 );
cloudsso_oidcdesktop_set($res, 44, $value );

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 (CloudSSO_OIDCDesktop Class)

When to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Object Oriented Interface

public function getProxySSL();
public function setProxySSL($value);

Procedural Interface

cloudsso_oidcdesktop_get($res, 45 );
cloudsso_oidcdesktop_set($res, 45, $value );

Default Value

0

Remarks

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 (CloudSSO_OIDCDesktop Class)

A username if authentication is to be used for the proxy.

Object Oriented Interface

public function getProxyUser();
public function setProxyUser($value);

Procedural Interface

cloudsso_oidcdesktop_get($res, 46 );
cloudsso_oidcdesktop_set($res, 46, $value );

Default Value

''

Remarks

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 (CloudSSO_OIDCDesktop Class)

The refresh token received from or sent to the token server.

Object Oriented Interface

public function getRefreshToken();
public function setRefreshToken($value);

Procedural Interface

cloudsso_oidcdesktop_get($res, 47 );
cloudsso_oidcdesktop_set($res, 47, $value );

Default Value

''

Remarks

This property is set by the class when it receives a refresh token after the AuthenticateUser method makes a request to an OpenID provider's token server.

Usage:

In cases where a user's session may last longer than the actual expiration period (see AccessTokenExp) for the user's AccessToken, the RefreshToken can be used to "refresh" the session. "Refreshing" the session allows the application to get a new access token without needing to have the user re-authorize the application again. To have the class use a RefreshToken, first the application will need to save the refresh token in a secure location. Refresh tokens are specific to the user, meaning each user will need to have their own RefreshToken saved. Once the application needs a new AccessToken, it will just set this property before calling the AuthenticateUser method.

Some OpenID providers will also return a newly issued ID Token when using a RefreshToken to get a new AccessToken. Additionally, some OpenID providers will either provide a new RefreshToken or reset the expiration date on the RefreshToken that was used. See the OpenID provider's documentation for more specifics.

Data Type

String

ReturnURL Property (CloudSSO_OIDCDesktop Class)

The URL where the user (browser) returns after authorization.

Object Oriented Interface

public function getReturnURL();
public function setReturnURL($value);

Procedural Interface

cloudsso_oidcdesktop_get($res, 48 );
cloudsso_oidcdesktop_set($res, 48, $value );

Default Value

''

Remarks

This property specifies the URL that is used by the authorization server to redirect the user after the user has finished the authorization process with the authorization server. This property corresponds to the redirect_uri query string parameter when AuthenticateUser creates the authorization URL.

Typically, this is automatically set to the internal web server that is created by the component upon calling AuthenticateUser or StartWebServer.

Data Type

String

SignerCertCount Property (CloudSSO_OIDCDesktop Class)

The number of records in the SignerCert arrays.

Object Oriented Interface

public function getSignerCertCount();

Procedural Interface

cloudsso_oidcdesktop_get($res, 49 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• SignerCertEncoded

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

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

Data Type

Integer

SignerCertEncoded Property (CloudSSO_OIDCDesktop Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSignerCertEncoded($signercertindex);

Procedural Interface

cloudsso_oidcdesktop_get($res, 76 , $signercertindex);

Default Value

''

Remarks

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.

The $signercertindex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerCertCount property.

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

Data Type

Binary String

SignerJWKS Property (CloudSSO_OIDCDesktop Class)

The JSON Web Key Set provided by an OpenID provider.

Object Oriented Interface

public function getSignerJWKS();

Procedural Interface

cloudsso_oidcdesktop_get($res, 77 );

Default Value

''

Remarks

This property holds the JSON Web Key Set provided by the OpenID Provider that will be used for signing ID Tokens.

Typically, this is returned from the DiscoveryDocDetailsSignerCertURL when the class makes a request to populate the SignerCerts properties. The RequestSignerCerts method can be used to manually make a request to the DiscoveryDocDetailsSignerCertURL; otherwise, the class will automatically make the request if the properties is not set and it needs the certificates to validate an ID Token.

This property can be saved/cached for later and used to reload the certificates by calling the LoadSignerJWKS method. This can be used to reduce how often the class makes requests to the DiscoveryDocDetailsSignerCertURL server.

This property is read-only.

Data Type

String

SSLAcceptServerCertEffectiveDate Property (CloudSSO_OIDCDesktop Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLAcceptServerCertEffectiveDate();

Procedural Interface

cloudsso_oidcdesktop_get($res, 78 );

Default Value

''

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLAcceptServerCertExpirationDate Property (CloudSSO_OIDCDesktop Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLAcceptServerCertExpirationDate();

Procedural Interface

cloudsso_oidcdesktop_get($res, 79 );

Default Value

''

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLAcceptServerCertExtendedKeyUsage Property (CloudSSO_OIDCDesktop Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLAcceptServerCertExtendedKeyUsage();

Procedural Interface

cloudsso_oidcdesktop_get($res, 80 );

Default Value

''

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprint Property (CloudSSO_OIDCDesktop Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertFingerprint();

Procedural Interface

cloudsso_oidcdesktop_get($res, 81 );

Default Value

''

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA1 Property (CloudSSO_OIDCDesktop Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertFingerprintSHA1();

Procedural Interface

cloudsso_oidcdesktop_get($res, 82 );

Default Value

''

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA256 Property (CloudSSO_OIDCDesktop Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertFingerprintSHA256();

Procedural Interface

cloudsso_oidcdesktop_get($res, 83 );

Default Value

''

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLAcceptServerCertIssuer Property (CloudSSO_OIDCDesktop Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertIssuer();

Procedural Interface

cloudsso_oidcdesktop_get($res, 84 );

Default Value

''

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKey Property (CloudSSO_OIDCDesktop Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKey();

Procedural Interface

cloudsso_oidcdesktop_get($res, 85 );

Default Value

''

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLAcceptServerCertPrivateKey may be available but not exportable. In this case, SSLAcceptServerCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKeyAvailable Property (CloudSSO_OIDCDesktop Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKeyAvailable();

Procedural Interface

cloudsso_oidcdesktop_get($res, 86 );

Default Value

false

Remarks

Whether a SSLAcceptServerCertPrivateKey is available for the selected certificate. If SSLAcceptServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLAcceptServerCertPrivateKeyContainer Property (CloudSSO_OIDCDesktop Class)

The name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKeyContainer();

Procedural Interface

cloudsso_oidcdesktop_get($res, 87 );

Default Value

''

Remarks

The name of the SSLAcceptServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKey Property (CloudSSO_OIDCDesktop Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertPublicKey();

Procedural Interface

cloudsso_oidcdesktop_get($res, 88 );

Default Value

''

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyAlgorithm Property (CloudSSO_OIDCDesktop Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSSLAcceptServerCertPublicKeyAlgorithm();

Procedural Interface

cloudsso_oidcdesktop_get($res, 89 );

Default Value

''

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyLength Property (CloudSSO_OIDCDesktop Class)

The length of the certificate's public key (in bits).

Object Oriented Interface

public function getSSLAcceptServerCertPublicKeyLength();

Procedural Interface

cloudsso_oidcdesktop_get($res, 90 );

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLAcceptServerCertSerialNumber Property (CloudSSO_OIDCDesktop Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLAcceptServerCertSerialNumber();

Procedural Interface

cloudsso_oidcdesktop_get($res, 91 );

Default Value

''

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLAcceptServerCertSignatureAlgorithm Property (CloudSSO_OIDCDesktop Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLAcceptServerCertSignatureAlgorithm();

Procedural Interface

cloudsso_oidcdesktop_get($res, 92 );

Default Value

''

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLAcceptServerCertStore Property (CloudSSO_OIDCDesktop Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLAcceptServerCertStore();
public function setSSLAcceptServerCertStore($value);

Procedural Interface

cloudsso_oidcdesktop_get($res, 93 );
cloudsso_oidcdesktop_set($res, 93, $value );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

The SSLAcceptServerCertStoreType property denotes the type of the certificate store specified by SSLAcceptServerCertStore. If the store is password-protected, specify the password in SSLAcceptServerCertStorePassword.

SSLAcceptServerCertStore is used in conjunction with the SSLAcceptServerCertSubject property to specify client certificates. If SSLAcceptServerCertStore has a value, and SSLAcceptServerCertSubject or SSLAcceptServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLAcceptServerCertSubject 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 cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Binary String

SSLAcceptServerCertStorePassword Property (CloudSSO_OIDCDesktop Class)

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

Object Oriented Interface

public function getSSLAcceptServerCertStorePassword();
public function setSSLAcceptServerCertStorePassword($value);

Procedural Interface

cloudsso_oidcdesktop_get($res, 94 );
cloudsso_oidcdesktop_set($res, 94, $value );

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

SSLAcceptServerCertStoreType Property (CloudSSO_OIDCDesktop Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLAcceptServerCertStoreType();
public function setSSLAcceptServerCertStoreType($value);

Procedural Interface

cloudsso_oidcdesktop_get($res, 95 );
cloudsso_oidcdesktop_set($res, 95, $value );

Default Value

0

Remarks

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

SSLAcceptServerCertSubjectAltNames Property (CloudSSO_OIDCDesktop Class)

Comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertSubjectAltNames();

Procedural Interface

cloudsso_oidcdesktop_get($res, 96 );

Default Value

''

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintMD5 Property (CloudSSO_OIDCDesktop Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintMD5();

Procedural Interface

cloudsso_oidcdesktop_get($res, 97 );

Default Value

''

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA1 Property (CloudSSO_OIDCDesktop Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintSHA1();

Procedural Interface

cloudsso_oidcdesktop_get($res, 98 );

Default Value

''

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA256 Property (CloudSSO_OIDCDesktop Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintSHA256();

Procedural Interface

cloudsso_oidcdesktop_get($res, 99 );

Default Value

''

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertUsage Property (CloudSSO_OIDCDesktop Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLAcceptServerCertUsage();

Procedural Interface

cloudsso_oidcdesktop_get($res, 100 );

Default Value

''

Remarks

The text description of SSLAcceptServerCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLAcceptServerCertUsageFlags Property (CloudSSO_OIDCDesktop Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertUsageFlags();

Procedural Interface

cloudsso_oidcdesktop_get($res, 101 );

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLAcceptServerCertUsageFlags is a combination of the following flags:

Please see the SSLAcceptServerCertUsage property for a text representation of SSLAcceptServerCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLAcceptServerCertVersion Property (CloudSSO_OIDCDesktop Class)

The certificate's version number.

Object Oriented Interface

public function getSSLAcceptServerCertVersion();

Procedural Interface

cloudsso_oidcdesktop_get($res, 102 );

Default Value

''

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLAcceptServerCertSubject Property (CloudSSO_OIDCDesktop Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLAcceptServerCertSubject();
public function setSSLAcceptServerCertSubject($value);

Procedural Interface

cloudsso_oidcdesktop_get($res, 103 );
cloudsso_oidcdesktop_set($res, 103, $value );

Default Value

''

Remarks

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

SSLAcceptServerCertEncoded Property (CloudSSO_OIDCDesktop Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLAcceptServerCertEncoded();
public function setSSLAcceptServerCertEncoded($value);

Procedural Interface

cloudsso_oidcdesktop_get($res, 104 );
cloudsso_oidcdesktop_set($res, 104, $value );

Default Value

''

Remarks

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

SSLCertEffectiveDate Property (CloudSSO_OIDCDesktop Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLCertEffectiveDate();

Procedural Interface

cloudsso_oidcdesktop_get($res, 105 );

Default Value

''

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLCertExpirationDate Property (CloudSSO_OIDCDesktop Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLCertExpirationDate();

Procedural Interface

cloudsso_oidcdesktop_get($res, 106 );

Default Value

''

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLCertExtendedKeyUsage Property (CloudSSO_OIDCDesktop Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLCertExtendedKeyUsage();

Procedural Interface

cloudsso_oidcdesktop_get($res, 107 );

Default Value

''

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLCertFingerprint Property (CloudSSO_OIDCDesktop Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getSSLCertFingerprint();

Procedural Interface

cloudsso_oidcdesktop_get($res, 108 );

Default Value

''

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLCertFingerprintSHA1 Property (CloudSSO_OIDCDesktop Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getSSLCertFingerprintSHA1();

Procedural Interface

cloudsso_oidcdesktop_get($res, 109 );

Default Value

''

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLCertFingerprintSHA256 Property (CloudSSO_OIDCDesktop Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getSSLCertFingerprintSHA256();

Procedural Interface

cloudsso_oidcdesktop_get($res, 110 );

Default Value

''

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLCertIssuer Property (CloudSSO_OIDCDesktop Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLCertIssuer();

Procedural Interface

cloudsso_oidcdesktop_get($res, 111 );

Default Value

''

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLCertPrivateKey Property (CloudSSO_OIDCDesktop Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLCertPrivateKey();

Procedural Interface

cloudsso_oidcdesktop_get($res, 112 );

Default Value

''

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLCertPrivateKey may be available but not exportable. In this case, SSLCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLCertPrivateKeyAvailable Property (CloudSSO_OIDCDesktop Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLCertPrivateKeyAvailable();

Procedural Interface

cloudsso_oidcdesktop_get($res, 113 );

Default Value

false

Remarks

Whether a SSLCertPrivateKey is available for the selected certificate. If SSLCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLCertPrivateKeyContainer Property (CloudSSO_OIDCDesktop Class)

The name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getSSLCertPrivateKeyContainer();

Procedural Interface

cloudsso_oidcdesktop_get($res, 114 );

Default Value

''

Remarks

The name of the SSLCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLCertPublicKey Property (CloudSSO_OIDCDesktop Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLCertPublicKey();

Procedural Interface

cloudsso_oidcdesktop_get($res, 115 );

Default Value

''

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLCertPublicKeyAlgorithm Property (CloudSSO_OIDCDesktop Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSSLCertPublicKeyAlgorithm();

Procedural Interface

cloudsso_oidcdesktop_get($res, 116 );

Default Value

''

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLCertPublicKeyLength Property (CloudSSO_OIDCDesktop Class)

The length of the certificate's public key (in bits).

Object Oriented Interface

public function getSSLCertPublicKeyLength();

Procedural Interface

cloudsso_oidcdesktop_get($res, 117 );

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLCertSerialNumber Property (CloudSSO_OIDCDesktop Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLCertSerialNumber();

Procedural Interface

cloudsso_oidcdesktop_get($res, 118 );

Default Value

''

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLCertSignatureAlgorithm Property (CloudSSO_OIDCDesktop Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLCertSignatureAlgorithm();

Procedural Interface

cloudsso_oidcdesktop_get($res, 119 );

Default Value

''

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLCertStore Property (CloudSSO_OIDCDesktop Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLCertStore();
public function setSSLCertStore($value);

Procedural Interface

cloudsso_oidcdesktop_get($res, 120 );
cloudsso_oidcdesktop_set($res, 120, $value );

Default Value

'MY'

Remarks

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 cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, 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 (CloudSSO_OIDCDesktop Class)

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

Object Oriented Interface

public function getSSLCertStorePassword();
public function setSSLCertStorePassword($value);

Procedural Interface

cloudsso_oidcdesktop_get($res, 121 );
cloudsso_oidcdesktop_set($res, 121, $value );

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 (CloudSSO_OIDCDesktop Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLCertStoreType();
public function setSSLCertStoreType($value);

Procedural Interface

cloudsso_oidcdesktop_get($res, 122 );
cloudsso_oidcdesktop_set($res, 122, $value );

Default Value

0

Remarks

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

SSLCertSubjectAltNames Property (CloudSSO_OIDCDesktop Class)

Comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface

public function getSSLCertSubjectAltNames();

Procedural Interface

cloudsso_oidcdesktop_get($res, 123 );

Default Value

''

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLCertThumbprintMD5 Property (CloudSSO_OIDCDesktop Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintMD5();

Procedural Interface

cloudsso_oidcdesktop_get($res, 124 );

Default Value

''

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertThumbprintSHA1 Property (CloudSSO_OIDCDesktop Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA1();

Procedural Interface

cloudsso_oidcdesktop_get($res, 125 );

Default Value

''

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertThumbprintSHA256 Property (CloudSSO_OIDCDesktop Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA256();

Procedural Interface

cloudsso_oidcdesktop_get($res, 126 );

Default Value

''

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertUsage Property (CloudSSO_OIDCDesktop Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLCertUsage();

Procedural Interface

cloudsso_oidcdesktop_get($res, 127 );

Default Value

''

Remarks

The text description of SSLCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLCertUsageFlags Property (CloudSSO_OIDCDesktop Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLCertUsageFlags();

Procedural Interface

cloudsso_oidcdesktop_get($res, 128 );

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLCertUsageFlags is a combination of the following flags:

Please see the SSLCertUsage property for a text representation of SSLCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLCertVersion Property (CloudSSO_OIDCDesktop Class)

The certificate's version number.

Object Oriented Interface

public function getSSLCertVersion();

Procedural Interface

cloudsso_oidcdesktop_get($res, 129 );

Default Value

''

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLCertSubject Property (CloudSSO_OIDCDesktop Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLCertSubject();
public function setSSLCertSubject($value);

Procedural Interface

cloudsso_oidcdesktop_get($res, 130 );
cloudsso_oidcdesktop_set($res, 130, $value );

Default Value

''

Remarks

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

SSLCertEncoded Property (CloudSSO_OIDCDesktop Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLCertEncoded();
public function setSSLCertEncoded($value);

Procedural Interface

cloudsso_oidcdesktop_get($res, 131 );
cloudsso_oidcdesktop_set($res, 131, $value );

Default Value

''

Remarks

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

SSLProvider Property (CloudSSO_OIDCDesktop Class)

The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.

Object Oriented Interface

public function getSSLProvider();
public function setSSLProvider($value);

Procedural Interface

cloudsso_oidcdesktop_get($res, 132 );
cloudsso_oidcdesktop_set($res, 132, $value );

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 as follows:

Additional Notes

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

SSLServerCertEffectiveDate Property (CloudSSO_OIDCDesktop Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLServerCertEffectiveDate();

Procedural Interface

cloudsso_oidcdesktop_get($res, 133 );

Default Value

''

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLServerCertExpirationDate Property (CloudSSO_OIDCDesktop Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLServerCertExpirationDate();

Procedural Interface

cloudsso_oidcdesktop_get($res, 134 );

Default Value

''

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLServerCertExtendedKeyUsage Property (CloudSSO_OIDCDesktop Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLServerCertExtendedKeyUsage();

Procedural Interface

cloudsso_oidcdesktop_get($res, 135 );

Default Value

''

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLServerCertFingerprint Property (CloudSSO_OIDCDesktop Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getSSLServerCertFingerprint();

Procedural Interface

cloudsso_oidcdesktop_get($res, 136 );

Default Value

''

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA1 Property (CloudSSO_OIDCDesktop Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getSSLServerCertFingerprintSHA1();

Procedural Interface

cloudsso_oidcdesktop_get($res, 137 );

Default Value

''

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA256 Property (CloudSSO_OIDCDesktop Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getSSLServerCertFingerprintSHA256();

Procedural Interface

cloudsso_oidcdesktop_get($res, 138 );

Default Value

''

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLServerCertIssuer Property (CloudSSO_OIDCDesktop Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLServerCertIssuer();

Procedural Interface

cloudsso_oidcdesktop_get($res, 139 );

Default Value

''

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLServerCertPrivateKey Property (CloudSSO_OIDCDesktop Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLServerCertPrivateKey();

Procedural Interface

cloudsso_oidcdesktop_get($res, 140 );

Default Value

''

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLServerCertPrivateKey may be available but not exportable. In this case, SSLServerCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLServerCertPrivateKeyAvailable Property (CloudSSO_OIDCDesktop Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLServerCertPrivateKeyAvailable();

Procedural Interface

cloudsso_oidcdesktop_get($res, 141 );

Default Value

false

Remarks

Whether a SSLServerCertPrivateKey is available for the selected certificate. If SSLServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLServerCertPrivateKeyContainer Property (CloudSSO_OIDCDesktop Class)

The name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getSSLServerCertPrivateKeyContainer();

Procedural Interface

cloudsso_oidcdesktop_get($res, 142 );

Default Value

''

Remarks

The name of the SSLServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLServerCertPublicKey Property (CloudSSO_OIDCDesktop Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLServerCertPublicKey();

Procedural Interface

cloudsso_oidcdesktop_get($res, 143 );

Default Value

''

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLServerCertPublicKeyAlgorithm Property (CloudSSO_OIDCDesktop Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSSLServerCertPublicKeyAlgorithm();

Procedural Interface

cloudsso_oidcdesktop_get($res, 144 );

Default Value

''

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLServerCertPublicKeyLength Property (CloudSSO_OIDCDesktop Class)

The length of the certificate's public key (in bits).

Object Oriented Interface

public function getSSLServerCertPublicKeyLength();

Procedural Interface

cloudsso_oidcdesktop_get($res, 145 );

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLServerCertSerialNumber Property (CloudSSO_OIDCDesktop Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLServerCertSerialNumber();

Procedural Interface

cloudsso_oidcdesktop_get($res, 146 );

Default Value

''

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLServerCertSignatureAlgorithm Property (CloudSSO_OIDCDesktop Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLServerCertSignatureAlgorithm();

Procedural Interface

cloudsso_oidcdesktop_get($res, 147 );

Default Value

''

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLServerCertStore Property (CloudSSO_OIDCDesktop Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLServerCertStore();

Procedural Interface

cloudsso_oidcdesktop_get($res, 148 );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

The SSLServerCertStoreType property denotes the type of the certificate store specified by SSLServerCertStore. If the store is password-protected, specify the password in SSLServerCertStorePassword.

SSLServerCertStore is used in conjunction with the SSLServerCertSubject property to specify client certificates. If SSLServerCertStore has a value, and SSLServerCertSubject or SSLServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLServerCertSubject 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 cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

This property is read-only.

Data Type

Binary String

SSLServerCertStorePassword Property (CloudSSO_OIDCDesktop Class)

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

Object Oriented Interface

public function getSSLServerCertStorePassword();

Procedural Interface

cloudsso_oidcdesktop_get($res, 149 );

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.

This property is read-only.

Data Type

String

SSLServerCertStoreType Property (CloudSSO_OIDCDesktop Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLServerCertStoreType();

Procedural Interface

cloudsso_oidcdesktop_get($res, 150 );

Default Value

0

Remarks

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:

This property is read-only.

Data Type

Integer

SSLServerCertSubjectAltNames Property (CloudSSO_OIDCDesktop Class)

Comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface

public function getSSLServerCertSubjectAltNames();

Procedural Interface

cloudsso_oidcdesktop_get($res, 151 );

Default Value

''

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLServerCertThumbprintMD5 Property (CloudSSO_OIDCDesktop Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintMD5();

Procedural Interface

cloudsso_oidcdesktop_get($res, 152 );

Default Value

''

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA1 Property (CloudSSO_OIDCDesktop Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintSHA1();

Procedural Interface

cloudsso_oidcdesktop_get($res, 153 );

Default Value

''

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA256 Property (CloudSSO_OIDCDesktop Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintSHA256();

Procedural Interface

cloudsso_oidcdesktop_get($res, 154 );

Default Value

''

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertUsage Property (CloudSSO_OIDCDesktop Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLServerCertUsage();

Procedural Interface

cloudsso_oidcdesktop_get($res, 155 );

Default Value

''

Remarks

The text description of SSLServerCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLServerCertUsageFlags Property (CloudSSO_OIDCDesktop Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLServerCertUsageFlags();

Procedural Interface

cloudsso_oidcdesktop_get($res, 156 );

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLServerCertUsageFlags is a combination of the following flags:

Please see the SSLServerCertUsage property for a text representation of SSLServerCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLServerCertVersion Property (CloudSSO_OIDCDesktop Class)

The certificate's version number.

Object Oriented Interface

public function getSSLServerCertVersion();

Procedural Interface

cloudsso_oidcdesktop_get($res, 157 );

Default Value

''

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLServerCertSubject Property (CloudSSO_OIDCDesktop Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLServerCertSubject();

Procedural Interface

cloudsso_oidcdesktop_get($res, 158 );

Default Value

''

Remarks

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.

This property is read-only.

Data Type

String

SSLServerCertEncoded Property (CloudSSO_OIDCDesktop Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLServerCertEncoded();

Procedural Interface

cloudsso_oidcdesktop_get($res, 159 );

Default Value

''

Remarks

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 (CloudSSO_OIDCDesktop Class)

An opaque value used to maintain state between the request and response.

Object Oriented Interface

public function getState();
public function setState($value);

Procedural Interface

cloudsso_oidcdesktop_get($res, 160 );
cloudsso_oidcdesktop_set($res, 160, $value );

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.

Data Type

String

Timeout Property (CloudSSO_OIDCDesktop Class)

The timeout for the class.

Object Oriented Interface

public function getTimeout();
public function setTimeout($value);

Procedural Interface

cloudsso_oidcdesktop_get($res, 161 );
cloudsso_oidcdesktop_set($res, 161, $value );

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.

Note: By default, all timeouts are inactivity timeouts, that is, 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

UseNonce Property (CloudSSO_OIDCDesktop Class)

Whether the Nonce parameter is added.

Object Oriented Interface

public function getUseNonce();
public function setUseNonce($value);

Procedural Interface

cloudsso_oidcdesktop_get($res, 162 );
cloudsso_oidcdesktop_set($res, 162, $value );

Default Value

false

Remarks

If this property is set to true, the nonce parameter will be added to the OIDC authorization request when GetAuthorizationURL is called. In OpenID Connect, the nonce parameter is provided during the authorization request. Then, when the OpenID Provider issues an ID Token, they will include the nonce claim with the same value (similar to State).

If the Nonce configuration setting is not set before calling GetAuthorizationURL the class will generate a new one and set the Nonce setting. The same nonce value will need to be supplied to the class before calling the ProcessOIDCResponse or ValidateIdToken methods. When the class validates an ID Token, it will check the Nonce configuration setting if a nonce claim is found. By default, the nonce claim is not required but setting this property to true will require the nonce claim to be present and match the Nonce configuration setting.

Data Type

Boolean

UsePKCE Property (CloudSSO_OIDCDesktop Class)

Whether Proof Key for Code Exchange (PKCE) should be used.

Object Oriented Interface

public function getUsePKCE();
public function setUsePKCE($value);

Procedural Interface

cloudsso_oidcdesktop_get($res, 163 );
cloudsso_oidcdesktop_set($res, 163, $value );

Default Value

false

Remarks

If this property is specified, the class will use Proof Key for Code Exchange (PKCE) as defined by RFC 7636 when AuthenticateUser is called. This applies when GrantType is set to the Authorization Code or Hybrid grant types. The PKCE verifier that is generated by the class will be set to the PKCEVerifier configuration setting.

Data Type

Boolean

UserDetailsAddrCountry Property (CloudSSO_OIDCDesktop Class)

The country name portion of the user's address.

Object Oriented Interface

public function getUserDetailsAddrCountry();

Procedural Interface

cloudsso_oidcdesktop_get($res, 164 );

Default Value

''

Remarks

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 (CloudSSO_OIDCDesktop Class)

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

Object Oriented Interface

public function getUserDetailsAddrFormatted();

Procedural Interface

cloudsso_oidcdesktop_get($res, 165 );

Default Value

''

Remarks

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 (CloudSSO_OIDCDesktop Class)

The city or locality portion of the user's address.

Object Oriented Interface

public function getUserDetailsAddrLocality();

Procedural Interface

cloudsso_oidcdesktop_get($res, 166 );

Default Value

''

Remarks

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 (CloudSSO_OIDCDesktop Class)

The zip code or postal code portion of the user's address.

Object Oriented Interface

public function getUserDetailsAddrPostalCode();

Procedural Interface

cloudsso_oidcdesktop_get($res, 167 );

Default Value

''

Remarks

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 (CloudSSO_OIDCDesktop Class)

The state, province, prefecture, or region portion of the user's address.

Object Oriented Interface

public function getUserDetailsAddrRegion();

Procedural Interface

cloudsso_oidcdesktop_get($res, 168 );

Default Value

''

Remarks

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 (CloudSSO_OIDCDesktop Class)

The street address portion of the user's address.

Object Oriented Interface

public function getUserDetailsAddrStreetAddr();

Procedural Interface

cloudsso_oidcdesktop_get($res, 169 );

Default Value

''

Remarks

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

UserDetailsBirthday Property (CloudSSO_OIDCDesktop Class)

The user's birthday.

Object Oriented Interface

public function getUserDetailsBirthday();

Procedural Interface

cloudsso_oidcdesktop_get($res, 170 );

Default Value

''

Remarks

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

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

Data Type

String

UserDetailsEmail Property (CloudSSO_OIDCDesktop Class)

The user's preferred email address.

Object Oriented Interface

public function getUserDetailsEmail();

Procedural Interface

cloudsso_oidcdesktop_get($res, 171 );

Default Value

''

Remarks

The user's preferred email address.

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

Data Type

String

UserDetailsEmailVerified Property (CloudSSO_OIDCDesktop Class)

Whether the user's email address has been verified.

Object Oriented Interface

public function getUserDetailsEmailVerified();

Procedural Interface

cloudsso_oidcdesktop_get($res, 172 );

Default Value

false

Remarks

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 (CloudSSO_OIDCDesktop Class)

The first name of the user.

Object Oriented Interface

public function getUserDetailsFirstName();

Procedural Interface

cloudsso_oidcdesktop_get($res, 173 );

Default Value

''

Remarks

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 (CloudSSO_OIDCDesktop Class)

The user's gender.

Object Oriented Interface

public function getUserDetailsGender();

Procedural Interface

cloudsso_oidcdesktop_get($res, 174 );

Default Value

''

Remarks

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

UserDetailsLastName Property (CloudSSO_OIDCDesktop Class)

The last name of the user.

Object Oriented Interface

public function getUserDetailsLastName();

Procedural Interface

cloudsso_oidcdesktop_get($res, 175 );

Default Value

''

Remarks

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 (CloudSSO_OIDCDesktop Class)

The end user's locale.

Object Oriented Interface

public function getUserDetailsLocale();

Procedural Interface

cloudsso_oidcdesktop_get($res, 176 );

Default Value

''

Remarks

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 (CloudSSO_OIDCDesktop Class)

The middle name of the user.

Object Oriented Interface

public function getUserDetailsMiddleName();

Procedural Interface

cloudsso_oidcdesktop_get($res, 177 );

Default Value

''

Remarks

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 (CloudSSO_OIDCDesktop Class)

The user's full name in displayable form including all name parts.

Object Oriented Interface

public function getUserDetailsName();

Procedural Interface

cloudsso_oidcdesktop_get($res, 178 );

Default Value

''

Remarks

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 (CloudSSO_OIDCDesktop Class)

The casual name of the user.

Object Oriented Interface

public function getUserDetailsNickname();

Procedural Interface

cloudsso_oidcdesktop_get($res, 179 );

Default Value

''

Remarks

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 (CloudSSO_OIDCDesktop Class)

The user's phone number.

Object Oriented Interface

public function getUserDetailsPhoneNumber();

Procedural Interface

cloudsso_oidcdesktop_get($res, 180 );

Default Value

''

Remarks

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 (CloudSSO_OIDCDesktop Class)

Whether the user's phone number has been verified.

Object Oriented Interface

public function getUserDetailsPhoneNumberVerified();

Procedural Interface

cloudsso_oidcdesktop_get($res, 181 );

Default Value

false

Remarks

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 (CloudSSO_OIDCDesktop Class)

The URL of the user's profile picture.

Object Oriented Interface

public function getUserDetailsPictureURL();

Procedural Interface

cloudsso_oidcdesktop_get($res, 182 );

Default Value

''

Remarks

The URL of the user's profile picture.

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

Data Type

String

UserDetailsPreferredUsername Property (CloudSSO_OIDCDesktop Class)

The shorthand name by which the end-user wishes to be referred.

Object Oriented Interface

public function getUserDetailsPreferredUsername();

Procedural Interface

cloudsso_oidcdesktop_get($res, 183 );

Default Value

''

Remarks

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 (CloudSSO_OIDCDesktop Class)

The URL of the user's profile page.

Object Oriented Interface

public function getUserDetailsProfileURL();

Procedural Interface

cloudsso_oidcdesktop_get($res, 184 );

Default Value

''

Remarks

The URL of the user's profile page.

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

Data Type

String

UserDetailsSubject Property (CloudSSO_OIDCDesktop Class)

The subject of the user that is being represented.

Object Oriented Interface

public function getUserDetailsSubject();

Procedural Interface

cloudsso_oidcdesktop_get($res, 185 );

Default Value

''

Remarks

The subject of the user that is being represented. This property is set when parsed from an ID Token or after retrieving the user info. Typically this represents the user of the application.

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

Data Type

String

UserDetailsUpdatedAt Property (CloudSSO_OIDCDesktop Class)

The time when the user's information was last updated.

Object Oriented Interface

public function getUserDetailsUpdatedAt();

Procedural Interface

cloudsso_oidcdesktop_get($res, 186 );

Default Value

0

Remarks

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 (CloudSSO_OIDCDesktop Class)

The URL of the user's website.

Object Oriented Interface

public function getUserDetailsWebsite();

Procedural Interface

cloudsso_oidcdesktop_get($res, 187 );

Default Value

''

Remarks

The URL of the user's website.

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

Data Type

String

UserDetailsZoneInfo Property (CloudSSO_OIDCDesktop Class)

The user's time zone.

Object Oriented Interface

public function getUserDetailsZoneInfo();

Procedural Interface

cloudsso_oidcdesktop_get($res, 188 );

Default Value

''

Remarks

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 (CloudSSO_OIDCDesktop Class)

The local port on which the embedded web server listens.

Object Oriented Interface

public function getWebServerPort();
public function setWebServerPort($value);

Procedural Interface

cloudsso_oidcdesktop_get($res, 189 );
cloudsso_oidcdesktop_set($res, 189, $value );

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

WebServerSSLCertEffectiveDate Property (CloudSSO_OIDCDesktop Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getWebServerSSLCertEffectiveDate();

Procedural Interface

cloudsso_oidcdesktop_get($res, 190 );

Default Value

''

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

WebServerSSLCertExpirationDate Property (CloudSSO_OIDCDesktop Class)

The date on which the certificate expires.

Object Oriented Interface

public function getWebServerSSLCertExpirationDate();

Procedural Interface

cloudsso_oidcdesktop_get($res, 191 );

Default Value

''

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

WebServerSSLCertExtendedKeyUsage Property (CloudSSO_OIDCDesktop Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getWebServerSSLCertExtendedKeyUsage();

Procedural Interface

cloudsso_oidcdesktop_get($res, 192 );

Default Value

''

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

WebServerSSLCertFingerprint Property (CloudSSO_OIDCDesktop Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getWebServerSSLCertFingerprint();

Procedural Interface

cloudsso_oidcdesktop_get($res, 193 );

Default Value

''

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

WebServerSSLCertFingerprintSHA1 Property (CloudSSO_OIDCDesktop Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getWebServerSSLCertFingerprintSHA1();

Procedural Interface

cloudsso_oidcdesktop_get($res, 194 );

Default Value

''

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

WebServerSSLCertFingerprintSHA256 Property (CloudSSO_OIDCDesktop Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getWebServerSSLCertFingerprintSHA256();

Procedural Interface

cloudsso_oidcdesktop_get($res, 195 );

Default Value

''

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

WebServerSSLCertIssuer Property (CloudSSO_OIDCDesktop Class)

The issuer of the certificate.

Object Oriented Interface

public function getWebServerSSLCertIssuer();

Procedural Interface

cloudsso_oidcdesktop_get($res, 196 );

Default Value

''

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

WebServerSSLCertPrivateKey Property (CloudSSO_OIDCDesktop Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getWebServerSSLCertPrivateKey();

Procedural Interface

cloudsso_oidcdesktop_get($res, 197 );

Default Value

''

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The WebServerSSLCertPrivateKey may be available but not exportable. In this case, WebServerSSLCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

WebServerSSLCertPrivateKeyAvailable Property (CloudSSO_OIDCDesktop Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getWebServerSSLCertPrivateKeyAvailable();

Procedural Interface

cloudsso_oidcdesktop_get($res, 198 );

Default Value

false

Remarks

Whether a WebServerSSLCertPrivateKey is available for the selected certificate. If WebServerSSLCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

WebServerSSLCertPrivateKeyContainer Property (CloudSSO_OIDCDesktop Class)

The name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getWebServerSSLCertPrivateKeyContainer();

Procedural Interface

cloudsso_oidcdesktop_get($res, 199 );

Default Value

''

Remarks

The name of the WebServerSSLCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

WebServerSSLCertPublicKey Property (CloudSSO_OIDCDesktop Class)

The public key of the certificate.

Object Oriented Interface

public function getWebServerSSLCertPublicKey();

Procedural Interface

cloudsso_oidcdesktop_get($res, 200 );

Default Value

''

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

WebServerSSLCertPublicKeyAlgorithm Property (CloudSSO_OIDCDesktop Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getWebServerSSLCertPublicKeyAlgorithm();

Procedural Interface

cloudsso_oidcdesktop_get($res, 201 );

Default Value

''

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

WebServerSSLCertPublicKeyLength Property (CloudSSO_OIDCDesktop Class)

The length of the certificate's public key (in bits).

Object Oriented Interface

public function getWebServerSSLCertPublicKeyLength();

Procedural Interface

cloudsso_oidcdesktop_get($res, 202 );

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

WebServerSSLCertSerialNumber Property (CloudSSO_OIDCDesktop Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getWebServerSSLCertSerialNumber();

Procedural Interface

cloudsso_oidcdesktop_get($res, 203 );

Default Value

''

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

WebServerSSLCertSignatureAlgorithm Property (CloudSSO_OIDCDesktop Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getWebServerSSLCertSignatureAlgorithm();

Procedural Interface

cloudsso_oidcdesktop_get($res, 204 );

Default Value

''

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

WebServerSSLCertStore Property (CloudSSO_OIDCDesktop Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getWebServerSSLCertStore();
public function setWebServerSSLCertStore($value);

Procedural Interface

cloudsso_oidcdesktop_get($res, 205 );
cloudsso_oidcdesktop_set($res, 205, $value );

Default Value

'MY'

Remarks

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 cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, 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 (CloudSSO_OIDCDesktop Class)

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

Object Oriented Interface

public function getWebServerSSLCertStorePassword();
public function setWebServerSSLCertStorePassword($value);

Procedural Interface

cloudsso_oidcdesktop_get($res, 206 );
cloudsso_oidcdesktop_set($res, 206, $value );

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 (CloudSSO_OIDCDesktop Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getWebServerSSLCertStoreType();
public function setWebServerSSLCertStoreType($value);

Procedural Interface

cloudsso_oidcdesktop_get($res, 207 );
cloudsso_oidcdesktop_set($res, 207, $value );

Default Value

0

Remarks

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

WebServerSSLCertSubjectAltNames Property (CloudSSO_OIDCDesktop Class)

Comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface

public function getWebServerSSLCertSubjectAltNames();

Procedural Interface

cloudsso_oidcdesktop_get($res, 208 );

Default Value

''

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

WebServerSSLCertThumbprintMD5 Property (CloudSSO_OIDCDesktop Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getWebServerSSLCertThumbprintMD5();

Procedural Interface

cloudsso_oidcdesktop_get($res, 209 );

Default Value

''

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

WebServerSSLCertThumbprintSHA1 Property (CloudSSO_OIDCDesktop Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getWebServerSSLCertThumbprintSHA1();

Procedural Interface

cloudsso_oidcdesktop_get($res, 210 );

Default Value

''

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

WebServerSSLCertThumbprintSHA256 Property (CloudSSO_OIDCDesktop Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getWebServerSSLCertThumbprintSHA256();

Procedural Interface

cloudsso_oidcdesktop_get($res, 211 );

Default Value

''

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

WebServerSSLCertUsage Property (CloudSSO_OIDCDesktop Class)

The text description of UsageFlags .

Object Oriented Interface

public function getWebServerSSLCertUsage();

Procedural Interface

cloudsso_oidcdesktop_get($res, 212 );

Default Value

''

Remarks

The text description of WebServerSSLCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

WebServerSSLCertUsageFlags Property (CloudSSO_OIDCDesktop Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getWebServerSSLCertUsageFlags();

Procedural Interface

cloudsso_oidcdesktop_get($res, 213 );

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of WebServerSSLCertUsageFlags is a combination of the following flags:

Please see the WebServerSSLCertUsage property for a text representation of WebServerSSLCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

WebServerSSLCertVersion Property (CloudSSO_OIDCDesktop Class)

The certificate's version number.

Object Oriented Interface

public function getWebServerSSLCertVersion();

Procedural Interface

cloudsso_oidcdesktop_get($res, 214 );

Default Value

''

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

WebServerSSLCertSubject Property (CloudSSO_OIDCDesktop Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getWebServerSSLCertSubject();
public function setWebServerSSLCertSubject($value);

Procedural Interface

cloudsso_oidcdesktop_get($res, 215 );
cloudsso_oidcdesktop_set($res, 215, $value );

Default Value

''

Remarks

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

WebServerSSLCertEncoded Property (CloudSSO_OIDCDesktop Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getWebServerSSLCertEncoded();
public function setWebServerSSLCertEncoded($value);

Procedural Interface

cloudsso_oidcdesktop_get($res, 216 );
cloudsso_oidcdesktop_set($res, 216, $value );

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

WebServerSSLEnabled Property (CloudSSO_OIDCDesktop Class)

Whether the web server requires Secure Sockets Layer (SSL) connections.

Object Oriented Interface

public function getWebServerSSLEnabled();
public function setWebServerSSLEnabled($value);

Procedural Interface

cloudsso_oidcdesktop_get($res, 217 );
cloudsso_oidcdesktop_set($res, 217, $value );

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

AddParam Method (CloudSSO_OIDCDesktop Class)

Adds a name-value pair to the query string parameters of the outgoing request.

Object Oriented Interface

public function doAddParam($paramname, $paramvalue);

Procedural Interface

cloudsso_oidcdesktop_do_addparam($res, $paramname, $paramvalue);

Remarks

This method can be used to add query string parameters to the requests being made by the AuthenticateUser method.

For example, this can be used to set the ui_locales request parameter. This parameter allows you to provide language preferences to the authorization server for a more cohesive user experience. For example, the following informs the authorization server that the user would prefer French (Canada), French (General), and English (General), in that order.

oidc.AddParam("ui_locales", "fr-CA fr en");

AuthenticateUser Method (CloudSSO_OIDCDesktop Class)

Authenticates a user to the application.

Object Oriented Interface

public function doAuthenticateUser();

Procedural Interface

cloudsso_oidcdesktop_do_authenticateuser($res);

Remarks

This method will attempt to authenticate the current user using the setting from the following properties and fields:

• AuthorizationScope
• ClientId
• ClientSecret
• DiscoveryDocDetails
• GrantType
• RefreshToken
• ReturnURL
• UseNonce
• UsePKCE

The method will first try to launch a web browser window that directs a user to the configured OpenID Provider's authorization page if a RefreshToken is not provided to the class. See below for more information about refresh tokens. The user will then go through the authorization process with the OpenID Provider, and provide consent to allow the relying party (your application) access to their user information. Then, the OpenID provider will redirect the user back to the application.

At the same time that the user is directed to the authorization server, the class will also start an internal web server that will be listening for the user to get redirected back to it once the authorization process is complete. Once the user has been redirected, the web server will parse the information from the redirect. The exact information retrieved from this redirect depends on the grant type that is being used.

• ogtAuthorizationCode - code
• ogtHybrid - code, id_token
• ogtImplicit - token, id_token

The code parameter holders the authorization code that is proof that the authorization process with the user completed successfully. If found by the web server, the class will use that to make a request to the token server, exchanging it for an ID Token, access token, and an optional refresh token.

The id_token and token parameters provide the ID Token and access token respectively. Unlike the code parameter, the tokens are provided directly to the web server without needing to make additional requests to the token server. However, the use of these parameters are often not recommended due to security concerns.

Whenever an ID Token is found by the class either through the response from the token server or from the id_token parameter, the class will automatically parse and validate the ID Token. See ParseIdToken and ValidateIdToken methods for more information.

If a RefreshToken is provided to the class, the method can get a new set of tokens without needing to have a user re-authorize the application. The refresh token is used instead of the authorization code to make the request to the token server. This is useful to improve the user experience by reducing the amount of times the user needs to interact with the OpenID Provider.

Config Method (CloudSSO_OIDCDesktop Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

cloudsso_oidcdesktop_do_config($res, $configurationstring);

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.

DoEvents Method (CloudSSO_OIDCDesktop Class)

This method processes events from the internal message queue.

Object Oriented Interface

public function doEvents();

Procedural Interface

cloudsso_oidcdesktop_do_doevents($res);

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.

GetDiscoveryMetadata Method (CloudSSO_OIDCDesktop Class)

Gets a specific metadata value from the discovery document.

Object Oriented Interface

public function doGetDiscoveryMetadata($metadataname);

Procedural Interface

cloudsso_oidcdesktop_do_getdiscoverymetadata($res, $metadataname);

Remarks

This method will search the current discovery document for a specific metadata value. This can take the metadata name or the JSON path. This works on documents that have been provided by both the LoadDiscoveryDoc and RequestDiscoveryDoc methods. For example, to get the authorization endpoint metadata field from the document, both of the following are valid:

Metadata Name oidc.GetDiscoveryMetadata("authorization_endpoint");

JSON Path oidc.GetDiscoveryMetadata("/json/authorization_endpoint");

GetIdTokenClaim Method (CloudSSO_OIDCDesktop Class)

Gets a specific claim from the ID Token.

Object Oriented Interface

public function doGetIdTokenClaim($claimname);

Procedural Interface

cloudsso_oidcdesktop_do_getidtokenclaim($res, $claimname);

Remarks

This method will search the current ID Token for a specific claim. This can take the claim name (defined by the specification) or a JSON path. For example, to get the audience claim from the ID Token, both of the following are valid:

Claim Name oidc.GetIdTokenClaim("aud");

JSON Path oidc.GetIdTokenClaim("/json/aud");

GetQueryParam Method (CloudSSO_OIDCDesktop Class)

Gets a specific claim from the authorization response.

Object Oriented Interface

public function doGetQueryParam($paramname);

Procedural Interface

cloudsso_oidcdesktop_do_getqueryparam($res, $paramname);

Remarks

This method searches the last response from the latest AuthenticateUser method call for a specific query parameter. For example, if the request that was recently processed by the class contains the state parameter, then the following code would return the value of the state returned from the authorization server.

oidc.AuthenticateUser(); string state = oidc.GetQueryParam("state");

GetUserInfoClaim Method (CloudSSO_OIDCDesktop Class)

Gets a specific claim from the UserInfo response.

Object Oriented Interface

public function doGetUserInfoClaim($claimname);

Procedural Interface

cloudsso_oidcdesktop_do_getuserinfoclaim($res, $claimname);

Remarks

This method will search the most recent response from the RequestUserInfo method for a specific claim. This can take the claim name (defined by the specification) or a JSON path. For example, to get the audience claim from the response, both of the following are valid:

Claim Name oidc.GetUserInfoClaim("aud");

JSON Path oidc.GetUserInfoClaim("/json/aud");

Interrupt Method (CloudSSO_OIDCDesktop Class)

This method interrupts the current method.

Object Oriented Interface

public function doInterrupt();

Procedural Interface

cloudsso_oidcdesktop_do_interrupt($res);

Remarks

If there is no method in progress, Interrupt simply returns, doing nothing.

LoadDiscoveryDoc Method (CloudSSO_OIDCDesktop Class)

Loads in a raw discovery document.

Object Oriented Interface

public function doLoadDiscoveryDoc($documentdata);

Procedural Interface

cloudsso_oidcdesktop_do_loaddiscoverydoc($res, $documentdata);

Remarks

This method loads a discovery document directly from the documentData parameter. Typically, this can be used to reload a discovery document that has been previously retrieved by the RequestDiscoveryDoc method.

LoadSignerJWKS Method (CloudSSO_OIDCDesktop Class)

Loads in the signer JWKS directly from a raw JWKS blob.

Object Oriented Interface

public function doLoadSignerJWKS($jwksdata);

Procedural Interface

cloudsso_oidcdesktop_do_loadsignerjwks($res, $jwksdata);

Remarks

This method loads the JSON Web Keys Set (JWKS) provided through the jwksData parameter. Calling this method will set the SignerJWKS property and populate the SignerCerts properties without making a request to the DiscoveryDocDetailsSignerCertURL endpoint. Typically, this will be used to reload a JWKS that we previously requested by the RequestSignerCerts method.

ParseIdToken Method (CloudSSO_OIDCDesktop Class)

Parses an ID Token.

Object Oriented Interface

public function doParseIdToken();

Procedural Interface

cloudsso_oidcdesktop_do_parseidtoken($res);

Remarks

This method parses the current ID Token. If the method is able to successfully parse the ID Token, it will populate the IdTokenInfo and UserDetails properties. Any uncommon or custom claims can be retrieved by calling the GetIdTokenClaim method. The ID Token can be populated directly by setting the IdTokenIdTokenContent property or by calling the AuthenticateUser method. As a note, the AuthenticateUser method will automatically parse and validate any ID Token's if they are found during the authorization or authentication process.

See ValidateIdToken for information on validating an ID Token.

RequestDiscoveryDoc Method (CloudSSO_OIDCDesktop Class)

Requests the OpenID Discovery Document.

Object Oriented Interface

public function doRequestDiscoveryDoc($url);

Procedural Interface

cloudsso_oidcdesktop_do_requestdiscoverydoc($res, $url);

Remarks

This method gets the OpenID Connect Discovery Document specified by the URL parameter and parses the response. The discovery document contains details about the OpenID Provider configuration including endpoint URLs, supported claims and response types, and more.

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 RequestDiscoveryDoc before calling GetAuthorizationURL to populate the class properties with information required to request 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 DiscoveryDocDetails property is populated. The DiscoveryDocDetailsContent property may be stored and reloaded using the LoadDiscoveryDoc method to avoid calling RequestDiscoveryDoc on subsequent authorization requests.

To access values not automatically parsed by the class, the GetDiscoveryMetadata method can be used to query for a specific metadata entry.

RequestSignerCerts Method (CloudSSO_OIDCDesktop Class)

Requests the signing certificates from the OpenID provider.

Object Oriented Interface

public function doRequestSignerCerts();

Procedural Interface

cloudsso_oidcdesktop_do_requestsignercerts($res);

Remarks

This method makes a request to the DiscoveryDocDetailsSignerCertURL to get the current signer certificates for the OpenID provider. The OpenID provider will return a JSON Web Key Set (JWKS) that represents the set of signing certificates that might be used when signing ID Tokens. The class will automatically populate the SignerCerts properties with the signer certificates parsed from the JWKS. Additionally, this method will set the SignerJWKS property with the returned JWKS. The SignerJWKS property can be saved for later and used with the LoadSignerJWKS method to avoid needing to use this method for subsequent requests.

RequestUserInfo Method (CloudSSO_OIDCDesktop Class)

Requests the information of a user.

Object Oriented Interface

public function doRequestUserInfo();

Procedural Interface

cloudsso_oidcdesktop_do_requestuserinfo($res);

Remarks

This method makes a request to get a specific user's info based on the current AccessToken. The request is made to the UserInfo endpoint which is defined by the DiscoveryDocDetailsUserInfoURL property when parsed from a discovery document. The URL can also be provided directly to the class by setting the ServerUserInfoURL configuration setting.

When a valid response is returned from the UserInfo endpoint, the class will populate the properties in the UserDetails property. For uncommon or custom claims, the GetUserInfoClaim method can be used to get claims not covered by the UserDetails property.

Reset Method (CloudSSO_OIDCDesktop Class)

This method will reset the class.

Object Oriented Interface

public function doReset();

Procedural Interface

cloudsso_oidcdesktop_do_reset($res);

Remarks

This method will reset the class's properties to their default values.

StartWebServer Method (CloudSSO_OIDCDesktop Class)

Starts the embedded web server.

Object Oriented Interface

public function doStartWebServer();

Procedural Interface

cloudsso_oidcdesktop_do_startwebserver($res);

Remarks

This method starts the embedded web server. This method can be used to manually start the embedded web server. Under normal circumstances, this is not needed as the component will automatically start and stop the web server when AuthenticateUser is called. You may decide, however, to start the web server manually before calling AuthenticateUser. When called, this method will also populate ReturnURL with the address of the embedded server.

StopWebServer Method (CloudSSO_OIDCDesktop Class)

Stops the embedded web server.

Object Oriented Interface

public function doStopWebServer();

Procedural Interface

cloudsso_oidcdesktop_do_stopwebserver($res);

Remarks

This method stops the embedded web server. Under normal circumstances, the web server will be stopped automatically during the authorization process when AuthenticateUser is called. If ReUseWebServer is set to True, the server will not be automatically stopped, and this method must be called to stop the embedded web server.

ValidateIdToken Method (CloudSSO_OIDCDesktop Class)

Validates an ID Token.

Object Oriented Interface

public function doValidateIdToken();

Procedural Interface

cloudsso_oidcdesktop_do_validateidtoken($res);

Remarks

This method validates the current ID Token. The ID Token can be populated directly by setting the IdTokenIdTokenContent property or by calling the AuthenticateUser method. Typically, the class will automatically validate and parse an ID Token if it is found. This can be used to re-validate an ID Token if needed.

The method will first check the signature of the ID Token using the SignerCerts properties which contains the corresponding public certificates of the certificates used to sign the original ID Token. If the SignerCerts properties is not populated, then a request will be made to the DiscoveryDocDetailsSignerCertURL property or the ServerSignerCertURL configuration setting if set. This is equivalent to calling the RequestSignerCerts method.

Then, the class will verify that the IdTokenIssuer property matches what is expected in the DiscoveryDocDetailsIssuer property. Next, the IdTokenAudiences will be checked to ensure that it matches the ClientId property. The ExpectedIssuer and ExpectedAudience configuration settings can be used to override the typical expected values. The last check is to ensure that the IdTokenIssuedTime and IdTokenExpTime are valid based on the current time. Additionally, if the nbf (Not Before) claim is present, that will also be verified.

If verification fails, the class will throw an exception with the matching error code. If certain steps in the verification process should be skipped, the IdTokenVerificationFlags configuration setting can be used.

Error Event (CloudSSO_OIDCDesktop Class)

Fired when information is available about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

cloudsso_oidcdesktop_register_callback($res, 1, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

LaunchBrowser Event (CloudSSO_OIDCDesktop Class)

Fires before launching a browser with the authorization URL.

Object Oriented Interface

public function fireLaunchBrowser($param);

Procedural Interface

cloudsso_oidcdesktop_register_callback($res, 2, array($this, 'fireLaunchBrowser'));

Parameter List

 'url'
 'command'

Remarks

When the AuthenticateUser method is called, the class will fire this event with the Command, which will be executed by the class. The URL parameter will be the authorization URL that the user will be directed to authenticate.

Within this event, you may override the current value of either Command or URL and provide your own value. If Command is set to an empty string, the class will not attempt to launch the browser and instead you will be responsible for directing the user to the authorization URL specified by the URL parameter.

In Windows, ShellExecute is used to execute Command, which limits the verbs available for use in Command to:

• edit
• explore
• find
• open
• print

Log Event (CloudSSO_OIDCDesktop Class)

Fired once for each log message.

Object Oriented Interface

public function fireLog($param);

Procedural Interface

cloudsso_oidcdesktop_register_callback($res, 3, array($this, 'fireLog'));

Parameter List

 'loglevel'
 'message'
 'logtype'

Remarks

This event is fired once for each log message generated by the class. The verbosity is controlled by the LogLevel setting.

LogLevel indicates the level of message. Possible values are as follows:

The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.

The value 2 (Verbose) logs additional information about the request and response.

The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).

Message is the log entry.

LogType identifies the type of log entry. Possible values are as follows:

• "Info"
• "RequestHeaders"
• "ResponseHeaders"
• "RequestBody"
• "ResponseBody"
• "ProxyRequest"
• "ProxyResponse"
• "FirewallRequest"
• "FirewallResponse"

Redirect Event (CloudSSO_OIDCDesktop Class)

Fired when a redirection is received from the server.

Object Oriented Interface

public function fireRedirect($param);

Procedural Interface

cloudsso_oidcdesktop_register_callback($res, 4, array($this, 'fireRedirect'));

Parameter List

 'location'
 'accept'

Remarks

This event is fired in cases in which the client can decide whether or not to continue with the redirection process. The Accept parameter is always True by default, but if you do not want to follow the redirection, Accept may be set to False, in which case the class fails with an error. Location is the location to which the client is being redirected. Further control over redirection is provided in the FollowRedirects property.

SSLServerAuthentication Event (CloudSSO_OIDCDesktop Class)

Fired after the server presents its certificate to the client.

Object Oriented Interface

public function fireSSLServerAuthentication($param);

Procedural Interface

cloudsso_oidcdesktop_register_callback($res, 5, array($this, 'fireSSLServerAuthentication'));

Parameter List

 'certencoded'
 'certsubject'
 'certissuer'
 'status'
 'accept'

Remarks

During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

SSLStatus Event (CloudSSO_OIDCDesktop Class)

Fired when secure connection progress messages are available.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

cloudsso_oidcdesktop_register_callback($res, 6, array($this, 'fireSSLStatus'));

Parameter List

 'message'

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

Config Settings (OIDCDesktop Class)

The class accepts one or more of the following configuration settings. Configuration 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.

OIDCDesktop Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

Socket Config Settings

Base Config Settings

Trappable Errors (OIDCDesktop Class)

OIDCDesktop Errors

The class may also return one of the following error codes, which are inherited from other classes.