OpenID Class
Properties Methods Events Config Settings Errors
The OpenID class is used to verify the identify of a user as well as get basic profile information.
Syntax
class ipworksauth.OpenID
Remarks
The OpenID class implements an OpenID Connect 1.0 relying party (client) capable of authenticating a user and retrieving user information. OpenID Connect 1.0 is a simple identity layer on top of OAuth 2.0 and re-uses much of the functionality and concepts defined by OAuth 2.0.
To begin using the class you will first need to register your application with the service you want to use. During this process you should obtain a client_id and client_secret. The following sections discuss the typical steps to verify the identify of a user and obtain profile information.
Get the Discovery Document
Many OpenID providers provide information via a Discovery Document. The Discovery Document defines information such as the endpoint URLs for authentication, tokens, and user information requests. In addition details about the allowed parameters such as supported authorization scopes are defined in this document. The document at a URL which can be fetched and parsed by calling the get_discovery_doc method.
The discovery document URL is typically published by an OpenID provider 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 get_discovery_doc before calling get_authorization to populate the class properties with information required to complete the authorization. The retrieved information includes endpoint URLs as well as the OpenID public certificates used to verify the signature on the ID token. After calling this method the following properties are populated:
The above values may be stored, and later populated from the stored values, to avoid the requirement of calling get_discovery_doc on subsequent authorization requests.
The following discovery document fields are populated after get_discovery_doc returns:
- discovery_doc_details_authorization_url
- discovery_doc_details_claims_param_supported
- discovery_doc_details_issuer
- discovery_doc_details_signer_cert_url
- discovery_doc_details_registration_url
- discovery_doc_details_service_docs_url
- discovery_doc_details_supported_claims
- discovery_doc_details_supported_displays
- discovery_doc_details_supported_grant_types
- discovery_doc_details_supported_response_types
- discovery_doc_details_supported_scopes
- discovery_doc_details_token_url
- discovery_doc_details_user_info_url
To access values not automatically parsed by the class the XPath configuration setting may be set to retrieve a specific value. Alternatively the RawJSON setting returns the entire JSON document which may be parsed separately.
Note: Calling get_discovery_doc is not mandatory. If server information was stored from a previous call or is otherwise known ahead of time the following properties may be set in place of calling get_discovery_doc:
Examples of the above points:
openid.GetDiscoveryDoc("https://accounts.google.com/.well-known/openid-configuration");
// ... or ...
openid.ServerAuthURL = "https://accounts.google.com/o/oauth2/v2/auth";
openid.ServerTokenURL = "https://oauth2.googleapis.com/token";
openid.ServerUserInfoURL = "https://openidconnect.googleapis.com/v1/userinfo";
openid.SignerCertURL = "https://www.googleapis.com/oauth2/v3/certs";
// ... or ...
string rawjson = openid.Config("RawJSON");
Get Authorization
Before calling get_authorization the class may be configured for one of several flows defined by the grant_type property. These flows determine which information is returned by the authorization server and which information (if any) is returned by the token server.
Possible values for grant_type are:
- 0 (Authorization Code - Default)
- 1 (Implicit)
- 2 (Hybrid)
When using 0 (Authorization Code Flow - Default) an authorization code is returned from the server_auth_url and the class automatically contacts the server_token_url exchanges the authorization code for an ID token and access token.
When using 1 (Implicit Flow) the server_auth_url returns an ID token and access token directly. This is only recommended for implementations that are in-browser as this potentially exposes the tokens to the end-user and user agent itself.
When using 2 (Hybrid Flow) an authorization code and potentially one or more tokens are returned by the server_auth_url. The class will automatically contact the server_token_url to exchange the authorization code for an ID token and access token.
When grant_type and any other optional settings are set as desired, call get_authorization.
get_authorization performs several operations automatically depending on the value of client_profile. Please see the introduction section for the OpenID class for a detailed overview of the typical scenarios.
After authorization is complete user_details will be populated with the claims parsed from the ID token. This method also returns an authorization string. The authorization string grants access to additional resources as requested via the authorization_scope property. If access to another resource was requested the access token returned here may be set in the Authorization property of any other class (or passed as the value of the HTTP Authorization header).
get_user_info may be called after calling this method.
The following properties are applicable when calling this method:
- client_id (required)
- client_secret (required)
- server_auth_url (required - populated by get_discovery_doc.)
- server_token_url (required - populated by get_discovery_doc.)
- signer_cert_url (conditional - populated by get_discovery_doc. Required if signer_cert is not set.)
- signer_cert (conditional - required if signer_cert_url is not set.)
- authorization_scope
- client_profile
- grant_type
- params
- refresh_token
- return_url
- state
- timeout
- Display
- Prompt
- IDTokenHint
- LoginHint
- ResponseType
For the default Authorization Code flow GetAuthorization could work like this:
openid.ClientId = "client id";
openid.ClientSecret = "client secret";
openid.AuthorizationScope += " profile email"; // default value is 'openid'
openid.State = "application state";
string authToken = openid.GetAuthorization();
Get User Info
When get_authorization returns the user_details property is populated with information about the user as returned in the ID token from the authorization server. An additional operation, get_user_info may optionally be called to query the server_user_info_url for information about the user.
Before calling get_user_info method a successful call to get_authorization must be made. The access token returned by get_authorization is used by the OpenID provider at server_user_info_url to identify the user for which claims are being retrieved.
When this method is called the class requests the claims about the user from the server_user_info_url. The resulting claims are available in the UserDetail* properties.
Note: The get_user_info method will populate the UserDetail* properties with the claims returned in the ID token during the authorization process. This method may not need to be called in order to access the desired claims about the user.
openid.GetUserInfo();
// ... use the user info in the remainder of your application ...
Client Profile Notes
The client_profile defines the environment in which the class is being used, and controls how the class behaves in order to best suit that environment. Choose the profile that is closest to the runtime environment.
The following client types are currently supported by the class:
- Application (desktop application)
- WebServer (server side application such as a web site)
- Device (an application without browser access such as a game console)
- Mobile (phone or tablet application)
- Browser (javascript application)
- JWT (server to server authentication using a JWT bearer token such as Google service account authentication)
Application Profile
The Application profile is applicable to applications that are run directly by the user. For instance, a Windows form application would use the Application profile. To authorize your application (client) using the Application profile, use the following steps:
First, set client_profile to ocpApplication. This defines the profile the class will use. Set the client_id, client_secret, server_auth_url, and server_token_url to the values you obtained when registering your application.
Second, call get_authorization to begin the authorization process. When get_authorization is called, the class will build the URL to which the user will be directed and fire the on_launch_browser event. The class will then launch the browser using the command and URL shown in the on_launch_browser event and await the response. The duration for which the class will wait for a response is defined by BrowserResponseTimeout.
Third, the user will interact with the browser to authenticate and grant access to the connecting application. The user will then be redirected back to an embedded web server that was automatically started when get_authorization was called. At this time, the on_return_url event will fire. This event provides an opportunity to provide a custom response to your user that they will see in their browser.
Fourth, the class will then automatically exchange the grant that was returned by the authorization server for the access token using the HTTP endpoint specified in server_token_url.
The authorization is now complete and the get_authorization method will return the authorization string. The authorization string can then be used with any of our components by simply setting the returned value to the authorization property before making a request.
The following is a simple example:
component.ClientId = "CLIENT_ID";
component.ClientSecret = "CLIENT_ID";
component.ServerAuthURL = "https://accounts.google.com/o/oauth2/auth";
component.ServerTokenURL = "https://accounts.google.com/o/oauth2/token";
HTTP.Authorization = component.GetAuthorization();
HTTP.Get("https://www.googleapis.com/oauth2/v1/userinfo");
Web Profile
The Web profile is applicable to applications that are run on the server side when the user uses the application from a web browser. To authorize your application (client) using this profile, use the following steps:
First, set client_profile to ocpWeb. This defines the profile the component will use. Set the client_id, client_secret, server_auth_url, and server_token_url to the values you obtained when registering your application. Set return_url to the page on your site that will be the endpoint the user is redirected back to after authentication.
Second, call get_authorization_url. This will return a URL to which the user should be redirected. Redirect the user to this URL.
Third, after the user authenticates and is returned to the page on your site specified by return_url, parse the "code" query string parameter from the incoming request to get the authorization code from the authorization server. Then, set authorization_code property to the parsed value.
Fourth, after authorization_code is set, call get_authorization to exchange the code specified in authorization_code for a token from the server specified by server_token_url. get_authorization will then return the authorization string. The authorization string can be used with any of our components by simply setting the returned value to the authorization property before making a request.
For additional details for less common profile types please see client_profile.
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
access_token | This property includes the access token returned by the authorization server. |
access_token_exp | This property includes the lifetime of the access token. |
authorization_code | This property includes the authorization code that is exchanged for an access token. |
authorization_scope | The authorization scope used during authorization. |
client_id | This property includes the Id of the client assigned when registering the application. |
client_profile | This property includes the type of client that is requesting authorization. |
client_secret | This property includes the secret value for the client assigned when registering the application. |
connected | This shows whether the class is connected. |
cookie_count | The number of records in the Cookie arrays. |
cookie_domain | This is the domain of a received cookie. |
cookie_expiration | This property contains an expiration time for the cookie (if provided by the server). |
cookie_name | This property, contains the name of the cookie. |
cookie_path | This property contains a path name to limit the cookie to (if provided by the server). |
cookie_secure | This property contains the security flag of the received cookie. |
cookie_value | This property contains the value of the cookie. |
discovery_doc_details_authorization_url | This property holds the server authorization endpoint URL. |
discovery_doc_details_claims_param_supported | This property indicates whether the claims request parameter is supported by the Open ID provider. |
discovery_doc_details_issuer | This property holds the issuer identifier of the OpenID provider. |
discovery_doc_details_registration_url | This property holds the dynamic client registration URL. |
discovery_doc_details_service_docs_url | This property contains the URL of the human-readable service documentation. |
discovery_doc_details_signer_cert_url | This property holds the URL of the JSON Web Key Set used to verify signatures on values returned by the OpenID provider. |
discovery_doc_details_supported_claims | This property holds a comma separated list of claims that are supported by the OpenID provider. |
discovery_doc_details_supported_displays | This property holds a comma separated list of display values that are supported by the OpenID provider. |
discovery_doc_details_supported_grant_types | This property holds a comma separated list of grant types supported by the OpenID provider. |
discovery_doc_details_supported_response_types | This property hold a comma separated list of response types supported by the OpenID provider. |
discovery_doc_details_supported_scopes | This property hold a comma separated list of scopes that are supported by the OpenID provider. |
discovery_doc_details_token_url | This property holds the token endpoint URL. |
discovery_doc_details_user_info_url | This property holds the user info endpoint URL. |
firewall_auto_detect | This property tells the class whether or not to automatically detect and use firewall system settings, if available. |
firewall_type | This property determines the type of firewall to connect through. |
firewall_host | This property contains the name or IP address of firewall (optional). |
firewall_password | This property contains a password if authentication is to be used when connecting through the firewall. |
firewall_port | This property contains the transmission control protocol (TCP) port for the firewall Host . |
firewall_user | This property contains a user name if authentication is to be used connecting through a firewall. |
follow_redirects | This property determines what happens when the server issues a redirect. |
grant_type | The grant type defining the authentication flow. |
idle | The current status of the class. |
local_host | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
other_headers | This property includes other headers as determined by the user (optional). |
param_count | The number of records in the Param arrays. |
param_name | This property contains the name of the parameter to be used in the request or returned in the response. |
param_value | This property contains the value of the parameter to be used in the request or returned in the response. |
proxy_auth_scheme | This property is used to tell the class which type of authorization to perform when connecting to the proxy. |
proxy_auto_detect | This property tells the class whether or not to automatically detect and use proxy system settings, if available. |
proxy_password | This property contains a password if authentication is to be used for the proxy. |
proxy_port | This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80). |
proxy_server | If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified. |
proxy_ssl | This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy. |
proxy_user | This property contains a user name, if authentication is to be used for the proxy. |
refresh_token | This property specifies the refresh token received from or sent to the authorization server. |
return_url | This property includes the URL where the user (browser) returns after authenticating. |
server_auth_url | This property includes the URL of the authorization server. |
server_token_url | This property includes the URL used to obtain the access token. |
server_user_info_url | The URL of the OpenID provider's user info endpoint. |
signer_cert_encoded | This is the certificate (PEM/base64 encoded). |
signer_cert_store | This is the name of the certificate store for the client certificate. |
signer_cert_store_password | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
signer_cert_store_type | This is the type of certificate store for this certificate. |
signer_cert_subject | This is the subject of the certificate used for client authentication. |
signer_cert_url | The URL of the OpenID provider's signing certificate. |
ssl_accept_server_cert_encoded | This is the certificate (PEM/base64 encoded). |
ssl_cert_encoded | This is the certificate (PEM/base64 encoded). |
ssl_cert_store | This is the name of the certificate store for the client certificate. |
ssl_cert_store_password | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
ssl_cert_store_type | This is the type of certificate store for this certificate. |
ssl_cert_subject | This is the subject of the certificate used for client authentication. |
ssl_provider | This specifies the SSL/TLS implementation to use. |
ssl_server_cert_encoded | This is the certificate (PEM/base64 encoded). |
state | Opaque value used to maintain state between the request and response. |
timeout | A timeout for the class. |
transferred_data | This property includes the contents of the last response from the server. |
transferred_headers | This property includes the full set of headers as received from the server. |
use_pkce | This property specifies if Proof Key for Code Exchange (PKCE) should be used. |
user_details_addr_country | This property holds the country name portion of the user's address. |
user_details_addr_formatted | This property holds the full mailing address of the user, formatted for display or use on a mailing label. |
user_details_addr_locality | This property holds the city or locality portion of the user's address. |
user_details_addr_postal_code | This property holds the zip code or postal code portion of the user's address. |
user_details_addr_region | This property holds the state, province, prefecture, or region portion of the user's address. |
user_details_addr_street_addr | This property holds the street address portion of the user's address. |
user_details_audiences | This property contains a comma separated list of audiences for which the user information is intended. |
user_details_birthday | This property contains the user's birthday. |
user_details_email | This property contains the user's preferred email address. |
user_details_email_verified | This property indicates whether the user's email address has been verified. |
user_details_first_name | This property holds the first name of the user. |
user_details_gender | This property holds the user's gender. |
user_details_issuer | This property contains the identifier of the issuer who issued the ID token. |
user_details_last_name | This property holds the last name of the user. |
user_details_locale | This property holds the end user's locale. |
user_details_middle_name | This property holds the middle name of the user. |
user_details_name | This property contains the user's full name in displayable form including all name parts. |
user_details_nickname | This property holds the casual name of the user. |
user_details_phone_number | This property holds the user's phone number. |
user_details_phone_number_verified | This property indicates whether the user's phone number has been verified. |
user_details_picture_url | This property holds the URL of the user's profile picture. |
user_details_preferred_username | This property holds the shorthand name by which the end-user wishes to be referred. |
user_details_profile_url | This property holds the URL of the user's profile page. |
user_details_subject | This property holds the subject identifier of the token. |
user_details_token_auth_time | This property holds the time when authentication occurred. |
user_details_token_exp_time | This property holds the expiration time of the token. |
user_details_token_issued_at | This property holds the time when the token was issued. |
user_details_updated_at | This property holds the time when the user's information was last updated. |
user_details_website | This property holds the URL of the user's website. |
user_details_zone_info | This property holds the user's time zone. |
web_server_port | This property includes the local port on which the embedded web server listens. |
web_server_ssl_cert_store | This is the name of the certificate store for the client certificate. |
web_server_ssl_cert_store_password | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
web_server_ssl_cert_store_type | This is the type of certificate store for this certificate. |
web_server_ssl_cert_subject | This is the subject of the certificate used for client authentication. |
web_server_ssl_enabled | This property specifies whether the web server requires Secure Sockets Layer (SSL) connections. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
add_cookie | This method adds a cookie and the corresponding value to the outgoing request headers. |
add_param | This method adds a name-value pair to the query string parameters of outgoing request. |
config | Sets or retrieves a configuration setting. |
do_events | Processes events from the internal message queue. |
get_authorization | Gets the authorization string required to access the protected resource. |
get_authorization_url | This method builds and returns the URL to which the user should be redirected for authorization. |
get_discovery_doc | Gets the OpenID Discovery Document. |
get_param | This method gets a specific parameter from a query string. |
get_user_info | Retrieves claims about the user. |
interrupt | Interrupt the current method. |
reset | Reset the class. |
start_web_server | This method starts the embedded web server. |
stop_web_server | This method stops the embedded web server. |
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.
on_connected | This event is fired immediately after a connection completes (or fails). |
on_connection_status | This event is fired to indicate changes in the connection state. |
on_disconnected | This event is fired when a connection is closed. |
on_end_transfer | This event is fired when a document finishes transferring. |
on_error | Information about errors during data delivery. |
on_header | This event is fired every time a header line comes in. |
on_launch_browser | This event fires before launching a browser with the authorization URL. |
on_log | This event fires once for each log message. |
on_redirect | This event is fired when a redirection is received from the server. |
on_return_url | Fires when the user is redirected to the embedded web server. |
on_set_cookie | This event is fired for every cookie set by the server. |
on_ssl_server_authentication | Fired after the server presents its certificate to the client. |
on_ssl_status | Shows the progress of the secure connection. |
on_start_transfer | This event is fired when a document starts transferring (after the headers). |
on_status | This event is fired when the HTTP status line is received from the server. |
on_transfer | This event is fired while a document transfers (delivers document). |
Config Settings
The following is a list of config settings for the class with short descriptions. Click on the links for further details.
Display | The requested display options to present to the end user. |
IDToken | The raw ID token returned after authorization. |
IDTokenHint | An ID token value to be used as a hint about the user's session. |
LoginHint | The login hint sent to the authorization server. |
LogoutURL | The logout URL that is provided by the discovery document. |
Prompt | The requested conditions under which the authorization server prompts for login. |
RawJSON | A JSON string holding the last response. |
ResponseType | The value of the response_type request parameter. |
XChildCount | The number of child elements of the current element. |
XChildName[i] | The name of the child element. |
XChildXText[i] | The inner text of the child element. |
XElement | The name of the current element. |
XParent | The parent of the current element. |
XPath | Provides a way to point to a specific element in the returned XML or JSON response. |
XSubTree | A snapshot of the current element in the document. |
XText | The text of the current element. |
AuthorizationTokenType | The type of access token returned. |
BrowserResponseTimeout | Specifies the amount of time to wait for a response from the browser. |
DeviceGrantType | The grant type to be used when the ClientProfile is set to ocpDevice. |
DeviceUserCode | The device's user code when the ClientProfile is set to ocpDevice. |
FormVarCount | Specifies the number of additional form variables to include in the request. |
FormVarName[i] | Specifies the form variable name at the specified index. |
FormVarValue[i] | Specifies the form variable value at the specified index. |
IncludeEmptyRedirectURI | Whether an empty redirect_uri parameter is included in requests. |
JWTAudience | The JWT audience when the ClientProfile is set to ocpJWT. |
JWTCertStore | The name of the certificate store for the JWT signing certificate. |
JWTCertStorePassword | The JWT signing certificate password. |
JWTCertStoreType | The type of certificate store. |
JWTCertSubject | The JWT signing certificate subject. |
JWTIssuer | The JWT issuer when the ClientProfile is set to ocpJWT. |
JWTJSONKey | The file path of the JWT JSON Key, or a string containing its content. |
JWTPayload | The payload of the JWT access token if present. |
JWTServiceProvider | The service provider to which authentication is being performed. |
JWTSignatureAlgorithm | The signature algorithm used to sign the JWT. |
JWTSubject | The subject field in the JWT. |
JWTValidityTime | The amount of time in seconds for which the assertion in the JWT is valid. |
JWTXChildCount | The number of child elements of the current element. |
JWTXChildName[i] | The name of the child element. |
JWTXChildXText[i] | The inner text of the child element. |
JWTXElement | The name of the current element. |
JWTXParent | The parent of the current element. |
JWTXPath | Provides a way to point to a specific element in the returned payload of a JWT based access token. |
JWTXSubTree | A snapshot of the current element in the document. |
JWTXText | The text of the current element. |
Microsoft365AdminConsentError | The error message returned when the admin denies consent to the scopes. |
Microsoft365AdminConsentErrorDesc | The error description returned when the admin denies consent to the scopes. |
Microsoft365AdminConsentTenant | The tenant ID returned after the admin consents to the scopes. |
Office365ServiceAPIVersion | The API version of the Office 365 service being discovered. |
Office365ServiceCapability | The API capability of the Office 365 service being discovered. |
Office365ServiceEndpoint | The Office 365 endpoint for the service that matches the criteria specified. |
PasswordGrantUsername | The Username field when using the password grant type. |
PKCEChallengeEncoding | The PKCE code challenge method to use. |
PollingInterval | The interval in seconds between polling requests when the device client profile is used. |
ResponseCompanyImage | A URL or full path to a company logo. |
ResponseCompanyURL | A URL to the company website or similar resource. |
ResponseFailureHeading | Short header text indicating failure. |
ResponseFailureMessage | A description for a failed authorization. |
ResponseHelpURL | A URL to a help page or other resource. |
ResponseLicenseURL | A URL to licensing terms. |
ResponseProductImage | A URL or full path to a product image. |
ResponseProductURL | A URL to a product page or similar resource. |
ResponseSuccessHeading | Short header text indicating success. |
ResponseSuccessMessage | A description for a successful authorization. |
ReUseWebServer | Determines if the same server instance is used between requests. |
TokenInfoFieldCount | The number of fields in the tokeninfo service response. |
TokenInfoFieldName[i] | The name of the tokeninfo service response field. |
TokenInfoFieldValue[i] | The value of the tokeninfo service response field. |
TokenInfoURL | The URL of the tokeninfo service. |
ValidateToken | Validates the specified access token with a tokeninfo service. |
WebServerFailedResponse | The custom response that will be displayed to the user if authentication failed. |
WebServerHost | The hostname used by the embedded web server displayed in the ReturnURL. |
WebServerResponse | The custom response that will be displayed to the user. |
AcceptEncoding | Used to tell the server which types of content encodings the client supports. |
AllowHTTPCompression | This property enables HTTP compression for receiving data. |
AllowHTTPFallback | Whether HTTP/2 connections are permitted to fallback to HTTP/1.1. |
Append | Whether to append data to LocalFile. |
Authorization | The Authorization string to be sent to the server. |
BytesTransferred | Contains the number of bytes transferred in the response data. |
ChunkSize | Specifies the chunk size in bytes when using chunked encoding. |
CompressHTTPRequest | Set to true to compress the body of a PUT or POST request. |
EncodeURL | If set to True the URL will be encoded by the class. |
FollowRedirects | Determines what happens when the server issues a redirect. |
GetOn302Redirect | If set to True the class will perform a GET on the new location. |
HTTP2HeadersWithoutIndexing | HTTP2 headers that should not update the dynamic header table with incremental indexing. |
HTTPVersion | The version of HTTP used by the class. |
IfModifiedSince | A date determining the maximum age of the desired document. |
KeepAlive | Determines whether the HTTP connection is closed after completion of the request. |
KerberosSPN | The Service Principal Name for the Kerberos Domain Controller. |
LogLevel | The level of detail that is logged. |
MaxRedirectAttempts | Limits the number of redirects that are followed in a request. |
NegotiatedHTTPVersion | The negotiated HTTP version. |
OtherHeaders | Other headers as determined by the user (optional). |
ProxyAuthorization | The authorization string to be sent to the proxy server. |
ProxyAuthScheme | The authorization scheme to be used for the proxy. |
ProxyPassword | A password if authentication is to be used for the proxy. |
ProxyPort | Port for the proxy server (default 80). |
ProxyServer | Name or IP address of a proxy server (optional). |
ProxyUser | A user name if authentication is to be used for the proxy. |
SentHeaders | The full set of headers as sent by the client. |
StatusLine | The first line of the last response from the server. |
TransferredData | The contents of the last response from the server. |
TransferredDataLimit | The maximum number of incoming bytes to be stored by the class. |
TransferredHeaders | The full set of headers as received from the server. |
TransferredRequest | The full request as sent by the client. |
UseChunkedEncoding | Enables or Disables HTTP chunked encoding for transfers. |
UseIDNs | Whether to encode hostnames to internationalized domain names. |
UsePlatformHTTPClient | Whether or not to use the platform HTTP client. |
UserAgent | Information about the user agent (browser). |
ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
FirewallAutoDetect | Tells the class whether or not to automatically detect and use firewall system settings, if available. |
FirewallHost | Name or IP address of firewall (optional). |
FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
FirewallPort | The TCP port for the FirewallHost;. |
FirewallType | Determines the type of firewall to connect through. |
FirewallUser | A user name if authentication is to be used connecting through a firewall. |
KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
Linger | When set to True, connections are terminated gracefully. |
LingerTime | Time in seconds to have the connection linger. |
LocalHost | The name of the local host through which connections are initiated or accepted. |
LocalPort | The port in the local host where the class binds. |
MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
MaxTransferRate | The transfer rate limit in bytes per second. |
ProxyExceptionsList | A semicolon separated list of hosts and IPs to bypass when using a proxy. |
TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
TcpNoDelay | Whether or not to delay when sending packets. |
UseIPv6 | Whether to use IPv6. |
AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
FirewallData | Used to send extra data to the firewall. |
InBufferSize | The size in bytes of the incoming queue of the socket. |
OutBufferSize | The size in bytes of the outgoing queue of the socket. |
BuildInfo | Information about the product's build. |
CodePage | The system code page used for Unicode to Multibyte translations. |
LicenseInfo | Information about the current license. |
MaskSensitive | Whether sensitive data is masked in log messages. |
ProcessIdleEvents | Whether the class uses its internal event loop to process events when the main thread is idle. |
SelectWaitMillis | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. |
UseFIPSCompliantAPI | Tells the class whether or not to use FIPS certified APIs. |
UseInternalSecurityAPI | Tells the class whether or not to use the system security libraries or an internal implementation. |
access_token Property
This property includes the access token returned by the authorization server.
Syntax
def get_access_token() -> str: ... def set_access_token(value: str) -> None: ...
access_token = property(get_access_token, set_access_token)
Default Value
""
Remarks
This property will be populated with the access token returned by the authorization server after a call to get_authorization. This will be the raw access token, whereas the return value from the get_authorization method will also include the required data so that it can be passed directly to the Authorization property of other components or added as the value of the authorization header in another client implementation.
access_token_exp Property
This property includes the lifetime of the access token.
Syntax
def get_access_token_exp() -> int: ...
access_token_exp = property(get_access_token_exp, None)
Default Value
0
Remarks
This setting holds the lifetime of the access token in seconds. For instance the value 3600 indicates that the token will expire in one hour from the time it was generated.
This property is read-only.
authorization_code Property
This property includes the authorization code that is exchanged for an access token.
Syntax
def get_authorization_code() -> str: ... def set_authorization_code(value: str) -> None: ...
authorization_code = property(get_authorization_code, set_authorization_code)
Default Value
""
Remarks
This property is used with the AuthorizationCode grant_type. When client_profile is set to ocpApplication (Application flow), this property will be informational only, as the get_authorization method will automatically exchange this code for a token with the authorization server specified in server_token_url.
When client_profile is set to ocpWeb (Web flow), this property needs to be set to the authorization code returned from the authorization server. Typically, this value is parsed when the service redirects the user back to your website. See client_profile for more information.
If this property is set before calling get_authorization, the class will not make a request to the authorization sever and instead will attempt to exchange the code with the authorization server for an access token.
authorization_scope Property
The authorization scope used during authorization.
Syntax
def get_authorization_scope() -> str: ... def set_authorization_scope(value: str) -> None: ...
authorization_scope = property(get_authorization_scope, set_authorization_scope)
Default Value
"openid"
Remarks
This property specifies the authorization scopes sent in the authorization request. The value specified here must be a space separated list of scopes. For instance openid profile email.
The openid scope is always required to be present. The default value is openid.
After calling get_authorization this property will be updated with the scope sent in the response from the server and will indicate the scope that was actually granted.
client_id Property
This property includes the Id of the client assigned when registering the application.
Syntax
def get_client_id() -> str: ... def set_client_id(value: str) -> None: ...
client_id = property(get_client_id, set_client_id)
Default Value
""
Remarks
This property holds the Id of the client that was assigned when initially registering the application with the authorization server. This value must be specified before calling get_authorization or get_authorization_url.
client_profile Property
This property includes the type of client that is requesting authorization.
Syntax
def get_client_profile() -> int: ... def set_client_profile(value: int) -> None: ...
client_profile = property(get_client_profile, set_client_profile)
Default Value
0
Remarks
This defines the type of client that will be requesting authorization. Set this before calling get_authorization to inform the class to act accordingly. Possible values are as follows:
0 (ocpApplication - default) | User application, such as a Windows form application |
1 (ocpWeb) | Server-side application, such as a website |
2 (ocpDevice) | Device application without a browser, such as a game console |
3 (ocpMobile) | Mobile application with browser support, such as a smart phone or tablet |
4 (ocpBrowser) | Client-side browser application, such as JavaScript |
5 (ocpJWT) | Server-to-Server authentication using a JWT Bearer Token |
Application Profile
The Application profile is applicable to applications that are run directly by the user. For instance, a Windows form application would use the Application profile. To authorize your application (client) using the Application profile, use the following steps:
First, set client_profile to ocpApplication. This defines the profile the class will use. Set the client_id, client_secret, server_auth_url, and server_token_url to the values you obtained when registering your application.
Second, call get_authorization to begin the authorization process. When get_authorization is called, the class will build the URL to which the user will be directed and fire the on_launch_browser event. The class will then launch the browser using the command and URL shown in the on_launch_browser event and await the response. The duration for which the class will wait for a response is defined by BrowserResponseTimeout.
Third, the user will interact with the browser to authenticate and grant access to the connecting application. The user will then be redirected back to an embedded web server that was automatically started when get_authorization was called. At this time, the on_return_url event will fire. This event provides an opportunity to provide a custom response to your user that they will see in their browser.
Fourth, the class will then automatically exchange the grant that was returned by the authorization server for the access token using the HTTP endpoint specified in server_token_url.
The authorization is now complete and the get_authorization method will return the authorization string. The authorization string can then be used with any of our components by simply setting the returned value to the authorization property before making a request.
The following is a simple example:
component.ClientId = "CLIENT_ID";
component.ClientSecret = "CLIENT_ID";
component.ServerAuthURL = "https://accounts.google.com/o/oauth2/auth";
component.ServerTokenURL = "https://accounts.google.com/o/oauth2/token";
HTTP.Authorization = component.GetAuthorization();
HTTP.Get("https://www.googleapis.com/oauth2/v1/userinfo");
Web Profile
The Web profile is applicable to applications that are run on the server side when the user uses the application from a web browser. To authorize your application (client) using this profile, use the following steps:
First, set client_profile to ocpWeb. This defines the profile the component will use. Set the client_id, client_secret, server_auth_url, and server_token_url to the values you obtained when registering your application. Set return_url to the page on your site that will be the endpoint the user is redirected back to after authentication.
Second, call get_authorization_url. This will return a URL to which the user should be redirected. Redirect the user to this URL.
Third, after the user authenticates and is returned to the page on your site specified by return_url, parse the "code" query string parameter from the incoming request to get the authorization code from the authorization server. Then, set authorization_code property to the parsed value.
Fourth, after authorization_code is set, call get_authorization to exchange the code specified in authorization_code for a token from the server specified by server_token_url. get_authorization will then return the authorization string. The authorization string can be used with any of our components by simply setting the returned value to the authorization property before making a request.
Device Profile
The Device profile is applicable to applications that are run on devices for which a web browser cannot be used. For example, a game console would use the Device profile. To authorize your application (client) using the device client profile use the following steps:
First, set client_profile to ocpDevice. This defines the profile the class will use. Set the client_id, client_secret, server_auth_url, and server_token_url to the values you obtained when registering your application. Do not set return_url.
Second, call get_authorization_url. The class will automatically make a request to server_auth_url to obtain a user code for the device. The get_authorization_url method will return the URL your user must visit from another device or computer that has web browser support. The get_authorization_url method will also populate DeviceUserCode. This device user code must be provided to the user. The user will enter the code at the URL returned by get_authorization_url.
Third, at this time, call get_authorization. The class will begin polling the server specified in server_token_url. The polling interval is specified (in seconds) by the PollingInterval setting.
Fourth, after the user has authenticated, the get_authorization method will return the authorization string. To use the authorization string with any of our components, simply pass this value to the authorization property before making the request.
Mobile Profile
The Mobile profile is applicable to applications that are run on devices for which a web browser can be used. For instance, a mobile phone or tablet would use the Mobile profile. The behavior when using this profile is very similar to the Application profile. The only difference between the Mobile and Application profiles is the way the browser is launched. When set to the Mobile profile, the on_launch_browser event will fire but the class will not attempt to launch the browser automatically. The browser must be launched manually from code. This behavior is the only difference between the Mobile and Application profiles. Please read the steps for the Application profile for a more detailed look at the process.
JWT Bearer Token (Server-to-Server) Profile
The JWT (JSON Web Token) Bearer Token profile is available for server-to-server authentication. For instance this may be used by web applications to access a Google service. In this case, the application will access data on behalf of the service account, not the end user. End-user interaction is not required.
First, specify authorization_scope server_token_url and JWTServiceProvider.
Second, specify JWT-specific values. The use of the JWT profile also requires additional configuration settings to be specified, including a certificate with private key used to sign the JWT. Either specify the JWTJSONKey configuration setting, which will parse the necessary information automatically, or manually specify the following configuration settings:
- JWTIssuer (required)
- JWTAudience (required)
- JWTCertStoreType (required)
- JWTCertStore (required)
- JWTCertStorePassword (required)
- JWTCertSubject (required)
- JWTSubject
- JWTValidityTime
- JWTSignatureAlgorithm
Example 1. Google:
oauth.AuthorizationScope = "https://www.googleapis.com/auth/analytics";
oauth.ServerTokenURL = "https://www.googleapis.com/oauth2/v3/token";
oauth.ClientProfile = OauthClientProfiles.ocpJWT;
oauth.Config("JWTServiceProvider=0");
oauth.Config("JWTIssuer=CLIENT_ID");
oauth.Config("JWTAudience=https://www.googleapis.com/oauth2/v3/token");
oauth.Config("JWTCertStoreType=2");
oauth.Config("JWTCertStore=C:\\MyCertificate.p12");
oauth.Config("JWTCertStorePassword=password");
oauth.Config("JWTCertSubject=*");
oauth.Config("JWTValidityTime=5400"); //in seconds
string authStr = oauth.GetAuthorization();
Example 2. Microsoft:
oauth.ClientId = "Client_Id";
oauth.ClientProfile = OauthClientProfiles.ocpJWT;
oauth.AuthorizationScope = "https://graph.microsoft.com/.default";
oauth.ServerTokenURL = "https://login.microsoftonline.com/" + tenant_id + "/oauth2/V2.0/token";
oauth.Config("JWTServiceProvider=1");
oauth.Config("JWTIssuer=" + CLIENT_ID);
oauth.Config("JWTSubject=" + CLIENT_ID);
oauth.Config("JWTCertStoreType=2");
oauth.Config("JWTCertStore=C:\\MyCertificate.p12");
oauth.Config("JWTCertStorePassword=password");
oauth.Config("JWTCertSubject=*");
oauth.Config("JWTValidityTime=3600");
oauth.Config("JWTAudience=https://login.microsoftonline.com/"+ tenant_id + "/oauth2/V2.0/token");
string authStr = oauth.GetAuthorization();
client_secret Property
This property includes the secret value for the client assigned when registering the application.
Syntax
def get_client_secret() -> str: ... def set_client_secret(value: str) -> None: ...
client_secret = property(get_client_secret, set_client_secret)
Default Value
""
Remarks
This property holds the secret of the client that was assigned when initially registering the application with the authorization server. This value must be specified before calling get_authorization or get_authorization_url.
connected Property
This shows whether the class is connected.
Syntax
def get_connected() -> bool: ... def set_connected(value: bool) -> None: ...
connected = property(get_connected, set_connected)
Default Value
FALSE
Remarks
This property is used to determine whether or not the class is connected to the remote host.
Note: It is recommended to use the connect or disconnect method instead of setting this property.
cookie_count Property
The number of records in the Cookie arrays.
Syntax
def get_cookie_count() -> int: ... def set_cookie_count(value: int) -> None: ...
cookie_count = property(get_cookie_count, set_cookie_count)
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at cookie_count - 1.cookie_domain Property
This is the domain of a received cookie.
Syntax
def get_cookie_domain(cookie_index: int) -> str: ...
Default Value
""
Remarks
This is the domain of a received cookie. This property contains a domain name to limit the cookie to (if provided by the server). If the server does not provide a domain name, this property will contain an empty string. The convention in this case is to use the server name specified by url_server as the cookie domain.
The cookie_index parameter specifies the index of the item in the array. The size of the array is controlled by the cookie_count property.
This property is read-only.
cookie_expiration Property
This property contains an expiration time for the cookie (if provided by the server).
Syntax
def get_cookie_expiration(cookie_index: int) -> str: ...
Default Value
""
Remarks
This property contains an expiration time for the cookie (if provided by the server). The time format used is "Weekday, DD-Mon-YY HH:MM:SS GMT". If the server does not provide an expiration time, this property will contain an empty string. The convention is to drop the cookie at the end of the session.
The cookie_index parameter specifies the index of the item in the array. The size of the array is controlled by the cookie_count property.
This property is read-only.
cookie_name Property
This property, contains the name of the cookie.
Syntax
def get_cookie_name(cookie_index: int) -> str: ... def set_cookie_name(cookie_index: int, value: str) -> None: ...
Default Value
""
Remarks
This property, contains the name of the cookie.
This property, along with cookie_value, stores the cookie that is to be sent to the server. The on_set_cookie event displays the cookies sent by the server and their properties.
The cookie_index parameter specifies the index of the item in the array. The size of the array is controlled by the cookie_count property.
cookie_path Property
This property contains a path name to limit the cookie to (if provided by the server).
Syntax
def get_cookie_path(cookie_index: int) -> str: ...
Default Value
""
Remarks
This property contains a path name to limit the cookie to (if provided by the server). If the server does not provide a cookie path, the path property will be an empty string. The convention in this case is to use the path specified by url_path as the cookie path.
The cookie_index parameter specifies the index of the item in the array. The size of the array is controlled by the cookie_count property.
This property is read-only.
cookie_secure Property
This property contains the security flag of the received cookie.
Syntax
def get_cookie_secure(cookie_index: int) -> bool: ...
Default Value
FALSE
Remarks
This property contains the security flag of the received cookie. This property specifies whether the cookie is secure. If the value of this property is True, the cookie value must be submitted only through a secure (HTTPS) connection.
The cookie_index parameter specifies the index of the item in the array. The size of the array is controlled by the cookie_count property.
This property is read-only.
cookie_value Property
This property contains the value of the cookie.
Syntax
def get_cookie_value(cookie_index: int) -> str: ... def set_cookie_value(cookie_index: int, value: str) -> None: ...
Default Value
""
Remarks
This property contains the value of the cookie. A corresponding value is associated with the cookie specified by cookie_name. This property holds that value.
The on_set_cookie event provides the cookies set by the server.
The cookie_index parameter specifies the index of the item in the array. The size of the array is controlled by the cookie_count property.
discovery_doc_details_authorization_url Property
This property holds the server authorization endpoint URL.
Syntax
def get_discovery_doc_details_authorization_url() -> str: ...
discovery_doc_details_authorization_url = property(get_discovery_doc_details_authorization_url, None)
Default Value
""
Remarks
This property holds the server authorization endpoint URL.
This setting corresponds to the authorization_endpoint parameter in the discovery document.
This property is read-only.
discovery_doc_details_claims_param_supported Property
This property indicates whether the claims request parameter is supported by the Open ID provider.
Syntax
def get_discovery_doc_details_claims_param_supported() -> bool: ...
discovery_doc_details_claims_param_supported = property(get_discovery_doc_details_claims_param_supported, None)
Default Value
FALSE
Remarks
This property indicates whether the claims request parameter is supported by the Open ID provider.
This setting corresponds to the claims_parameter_supported parameter in the discovery document.
This property is read-only.
discovery_doc_details_issuer Property
This property holds the issuer identifier of the OpenID provider.
Syntax
def get_discovery_doc_details_issuer() -> str: ...
discovery_doc_details_issuer = property(get_discovery_doc_details_issuer, None)
Default Value
""
Remarks
This property holds the issuer identifier of the OpenID provider. This value is the same as the iss claim returned in ID tokens issued from this provider. The value is a URL with the https scheme with no query string or fragment component.
This setting corresponds to the issuer parameter in the discovery document.
This property is read-only.
discovery_doc_details_registration_url Property
This property holds the dynamic client registration URL.
Syntax
def get_discovery_doc_details_registration_url() -> str: ...
discovery_doc_details_registration_url = property(get_discovery_doc_details_registration_url, None)
Default Value
""
Remarks
This property holds the dynamic client registration URL.
This setting corresponds to the registration_endpoint parameter in the discovery document.
This property is read-only.
discovery_doc_details_service_docs_url Property
This property contains the URL of the human-readable service documentation.
Syntax
def get_discovery_doc_details_service_docs_url() -> str: ...
discovery_doc_details_service_docs_url = property(get_discovery_doc_details_service_docs_url, None)
Default Value
""
Remarks
This property contains the URL of the human-readable service documentation. The information at this URL is intended for developers integrating with the OpenID provider and may contain useful information.
This setting corresponds to the service_documentation parameter in the discovery document.
This property is read-only.
discovery_doc_details_signer_cert_url Property
This property holds the URL of the JSON Web Key Set used to verify signatures on values returned by the OpenID provider.
Syntax
def get_discovery_doc_details_signer_cert_url() -> str: ...
discovery_doc_details_signer_cert_url = property(get_discovery_doc_details_signer_cert_url, None)
Default Value
""
Remarks
This property holds the URL of the JSON Web Key Set used to verify signatures on values returned by the OpenID provider. The signer keys are automatically retrieved by the class when the ID Token signature verification is performed.
This setting corresponds to the jwks_uri parameter in the discovery document.
This property is read-only.
discovery_doc_details_supported_claims Property
This property holds a comma separated list of claims that are supported by the OpenID provider.
Syntax
def get_discovery_doc_details_supported_claims() -> str: ...
discovery_doc_details_supported_claims = property(get_discovery_doc_details_supported_claims, None)
Default Value
""
Remarks
This property holds a comma separated list of claims that are supported by the OpenID provider. For instance: aud,email,email_verified,exp,family_name,given_name,iat,iss,locale,name,picture,sub
This setting corresponds to the claims_supported parameter in the discovery document.
This property is read-only.
discovery_doc_details_supported_displays Property
This property holds a comma separated list of display values that are supported by the OpenID provider.
Syntax
def get_discovery_doc_details_supported_displays() -> str: ...
discovery_doc_details_supported_displays = property(get_discovery_doc_details_supported_displays, None)
Default Value
""
Remarks
This property holds a comma separated list of display values that are supported by the OpenID provider.
This setting corresponds to the display_values_supported parameter in the discovery document.
This property is read-only.
discovery_doc_details_supported_grant_types Property
This property holds a comma separated list of grant types supported by the OpenID provider.
Syntax
def get_discovery_doc_details_supported_grant_types() -> str: ...
discovery_doc_details_supported_grant_types = property(get_discovery_doc_details_supported_grant_types, None)
Default Value
""
Remarks
This property holds a comma separated list of grant types supported by the OpenID provider. If this value is not specified by the OpenID provider it is specified that authorization_code and implicit are supported by the OpenID provider.
This setting corresponds to the grant_types_supported parameter in the discovery document.
This property is read-only.
discovery_doc_details_supported_response_types Property
This property hold a comma separated list of response types supported by the OpenID provider.
Syntax
def get_discovery_doc_details_supported_response_types() -> str: ...
discovery_doc_details_supported_response_types = property(get_discovery_doc_details_supported_response_types, None)
Default Value
""
Remarks
This property hold a comma separated list of response types supported by the OpenID provider. If this value is not specified by the OpenID provider it is defined that the OpenID provider supports (at a minimum) code, id_token, and token id_token values.
This setting corresponds to the response_types_supported parameter in the discovery document.
This property is read-only.
discovery_doc_details_supported_scopes Property
This property hold a comma separated list of scopes that are supported by the OpenID provider.
Syntax
def get_discovery_doc_details_supported_scopes() -> str: ...
discovery_doc_details_supported_scopes = property(get_discovery_doc_details_supported_scopes, None)
Default Value
""
Remarks
This property hold a comma separated list of scopes that are supported by the OpenID provider. For instance: openid,email,profile
This setting corresponds to the scopes_supported parameter in the discovery document.
This property is read-only.
discovery_doc_details_token_url Property
This property holds the token endpoint URL.
Syntax
def get_discovery_doc_details_token_url() -> str: ...
discovery_doc_details_token_url = property(get_discovery_doc_details_token_url, None)
Default Value
""
Remarks
This property holds the token endpoint URL.
This setting corresponds to the token_endpoint parameter in the discovery document.
This property is read-only.
discovery_doc_details_user_info_url Property
This property holds the user info endpoint URL.
Syntax
def get_discovery_doc_details_user_info_url() -> str: ...
discovery_doc_details_user_info_url = property(get_discovery_doc_details_user_info_url, None)
Default Value
""
Remarks
This property holds the user info endpoint URL.
This setting corresponds to the userinfo_endpoint parameter in the discovery document.
This property is read-only.
firewall_auto_detect Property
This property tells the class whether or not to automatically detect and use firewall system settings, if available.
Syntax
def get_firewall_auto_detect() -> bool: ... def set_firewall_auto_detect(value: bool) -> None: ...
firewall_auto_detect = property(get_firewall_auto_detect, set_firewall_auto_detect)
Default Value
FALSE
Remarks
This property tells the class whether or not to automatically detect and use firewall system settings, if available.
firewall_type Property
This property determines the type of firewall to connect through.
Syntax
def get_firewall_type() -> int: ... def set_firewall_type(value: int) -> None: ...
firewall_type = property(get_firewall_type, set_firewall_type)
Default Value
0
Remarks
This property determines the type of firewall to connect through. The applicable values are as follows:
fwNone (0) | No firewall (default setting). |
fwTunnel (1) | Connect through a tunneling proxy. firewall_port is set to 80. |
fwSOCKS4 (2) | Connect through a SOCKS4 Proxy. firewall_port is set to 1080. |
fwSOCKS5 (3) | Connect through a SOCKS5 Proxy. firewall_port is set to 1080. |
fwSOCKS4A (10) | Connect through a SOCKS4A Proxy. firewall_port is set to 1080. |
firewall_host Property
This property contains the name or IP address of firewall (optional).
Syntax
def get_firewall_host() -> str: ... def set_firewall_host(value: str) -> None: ...
firewall_host = property(get_firewall_host, set_firewall_host)
Default Value
""
Remarks
This property contains the name or IP address of firewall (optional). If a firewall_host 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.
firewall_password Property
This property contains a password if authentication is to be used when connecting through the firewall.
Syntax
def get_firewall_password() -> str: ... def set_firewall_password(value: str) -> None: ...
firewall_password = property(get_firewall_password, set_firewall_password)
Default Value
""
Remarks
This property contains a password if authentication is to be used when connecting through the firewall. If firewall_host is specified, the firewall_user and firewall_password properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.
firewall_port Property
This property contains the transmission control protocol (TCP) port for the firewall Host .
Syntax
def get_firewall_port() -> int: ... def set_firewall_port(value: int) -> None: ...
firewall_port = property(get_firewall_port, set_firewall_port)
Default Value
0
Remarks
This property contains the transmission control protocol (TCP) port for the firewall firewall_host. See the description of the firewall_host property for details.
Note: This property is set automatically when firewall_type is set to a valid value. See the description of the firewall_type property for details.
firewall_user Property
This property contains a user name if authentication is to be used connecting through a firewall.
Syntax
def get_firewall_user() -> str: ... def set_firewall_user(value: str) -> None: ...
firewall_user = property(get_firewall_user, set_firewall_user)
Default Value
""
Remarks
This property contains a user name if authentication is to be used connecting through a firewall. If the firewall_host is specified, this property and firewall_password properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.
follow_redirects Property
This property determines what happens when the server issues a redirect.
Syntax
def get_follow_redirects() -> int: ... def set_follow_redirects(value: int) -> None: ...
follow_redirects = property(get_follow_redirects, set_follow_redirects)
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 url_scheme 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 on_redirect event is fired for every URL the product is redirected to. In the case of automatic redirections, the on_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.
grant_type Property
The grant type defining the authentication flow.
Syntax
def get_grant_type() -> int: ... def set_grant_type(value: int) -> None: ...
grant_type = property(get_grant_type, set_grant_type)
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 grant_type are:
- 0 (Authorization Code - Default)
- 1 (Implicit)
- 2 (Hybrid)
When using 0 (Authorization Code Flow - Default) an authorization code is returned from the server_auth_url and the class automatically contacts the server_token_url exchanges the authorization code for an ID token and access token.
When using 1 (Implicit Flow) the server_auth_url returns an ID token and access token directly. This is only recommended for implementations that are in-browser as this potentially exposes the tokens to the end-user and user agent itself.
When using 2 (Hybrid Flow) an authorization code and potentially one or more tokens are returned by the server_auth_url. The class will automatically contact the server_token_url to exchange the authorization code for an ID token and access token.
Additional Notes
The response_type request parameter is automatically set based on the value specified here. In some cases multiple values are acceptable and a default value is chosen automatically. To explicitly specify a response_type value for the chosen grant type set ResponseType after setting this property.
idle Property
The current status of the class.
Syntax
def get_idle() -> bool: ...
idle = property(get_idle, None)
Default Value
TRUE
Remarks
idle will be False if the component is currently busy (communicating and/or waiting for an answer), and True at all other times.
This property is read-only.
local_host Property
The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
Syntax
def get_local_host() -> str: ... def set_local_host(value: str) -> None: ...
local_host = property(get_local_host, set_local_host)
Default Value
""
Remarks
The local_host property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.
In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.
If the class is connected, the local_host property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface).
NOTE: local_host is not persistent. You must always set it in code, and never in the property window.
other_headers Property
This property includes other headers as determined by the user (optional).
Syntax
def get_other_headers() -> str: ... def set_other_headers(value: str) -> None: ...
other_headers = property(get_other_headers, set_other_headers)
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 content_type 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.
param_count Property
The number of records in the Param arrays.
Syntax
def get_param_count() -> int: ... def set_param_count(value: int) -> None: ...
param_count = property(get_param_count, set_param_count)
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at param_count - 1.param_name Property
This property contains the name of the parameter to be used in the request or returned in the response.
Syntax
def get_param_name(param_index: int) -> str: ... def set_param_name(param_index: int, value: str) -> None: ...
Default Value
""
Remarks
This property contains the name of the parameter to be used in the request or returned in the response.
The param_index parameter specifies the index of the item in the array. The size of the array is controlled by the param_count property.
param_value Property
This property contains the value of the parameter to be used in the request or returned in the response.
Syntax
def get_param_value(param_index: int) -> str: ... def set_param_value(param_index: int, value: str) -> None: ...
Default Value
""
Remarks
This property contains the value of the parameter to be used in the request or returned in the response. When issuing a request, the class will URL encode the value specified here. Returned values will be automatically URL decoded.
The param_index parameter specifies the index of the item in the array. The size of the array is controlled by the param_count property.
proxy_auth_scheme Property
This property is used to tell the class which type of authorization to perform when connecting to the proxy.
Syntax
def get_proxy_auth_scheme() -> int: ... def set_proxy_auth_scheme(value: int) -> None: ...
proxy_auth_scheme = property(get_proxy_auth_scheme, set_proxy_auth_scheme)
Default Value
0
Remarks
This property is used to tell the class which type of authorization to perform when connecting to the proxy. This is used only when the proxy_user and proxy_password properties are set.
proxy_auth_scheme should be set to authNone (3) when no authentication is expected.
By default, proxy_auth_scheme is authBasic (0), and if the proxy_user and proxy_password properties are set, the component will attempt basic authentication.
If proxy_auth_scheme is set to authDigest (1), digest authentication will be attempted instead.
If proxy_auth_scheme 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 proxy_auth_scheme is set to authNtlm (4), NTLM authentication will be used.
For security reasons, setting this property will clear the values of proxy_user and proxy_password.
proxy_auto_detect Property
This property tells the class whether or not to automatically detect and use proxy system settings, if available.
Syntax
def get_proxy_auto_detect() -> bool: ... def set_proxy_auto_detect(value: bool) -> None: ...
proxy_auto_detect = property(get_proxy_auto_detect, set_proxy_auto_detect)
Default Value
FALSE
Remarks
This property tells the class whether or not to automatically detect and use proxy system settings, if available. The default value is False.
proxy_password Property
This property contains a password if authentication is to be used for the proxy.
Syntax
def get_proxy_password() -> str: ... def set_proxy_password(value: str) -> None: ...
proxy_password = property(get_proxy_password, set_proxy_password)
Default Value
""
Remarks
This property contains a password if authentication is to be used for the proxy.
If proxy_auth_scheme is set to Basic Authentication, the proxy_user and proxy_password are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].
If proxy_auth_scheme is set to Digest Authentication, the proxy_user and proxy_password properties are used to respond to the Digest Authentication challenge from the server.
If proxy_auth_scheme is set to NTLM Authentication, the proxy_user and proxy_password properties are used to authenticate through NTLM negotiation.
proxy_port Property
This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80).
Syntax
def get_proxy_port() -> int: ... def set_proxy_port(value: int) -> None: ...
proxy_port = property(get_proxy_port, set_proxy_port)
Default Value
80
Remarks
This property contains the Transmission Control Protocol (TCP) port for the proxy proxy_server (default 80). See the description of the proxy_server property for details.
proxy_server Property
If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
Syntax
def get_proxy_server() -> str: ... def set_proxy_server(value: str) -> None: ...
proxy_server = property(get_proxy_server, set_proxy_server)
Default Value
""
Remarks
If a proxy proxy_server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
If the proxy_server property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the proxy_server property is set to the corresponding address. If the search is not successful, an error is returned.
proxy_ssl Property
This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy.
Syntax
def get_proxy_ssl() -> int: ... def set_proxy_ssl(value: int) -> None: ...
proxy_ssl = property(get_proxy_ssl, set_proxy_ssl)
Default Value
0
Remarks
This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:
psAutomatic (0) | Default setting. If the url is an https URL, the class will use the psTunnel option. If the url is an http URL, the class will use the psNever option. |
psAlways (1) | The connection is always SSL enabled. |
psNever (2) | The connection is not SSL enabled. |
psTunnel (3) | The connection is made through a tunneling (HTTP) proxy. |
proxy_user Property
This property contains a user name, if authentication is to be used for the proxy.
Syntax
def get_proxy_user() -> str: ... def set_proxy_user(value: str) -> None: ...
proxy_user = property(get_proxy_user, set_proxy_user)
Default Value
""
Remarks
This property contains a user name, if authentication is to be used for the proxy.
If proxy_auth_scheme is set to Basic Authentication, the proxy_user and proxy_password are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].
If proxy_auth_scheme is set to Digest Authentication, the proxy_user and proxy_password properties are used to respond to the Digest Authentication challenge from the server.
If proxy_auth_scheme is set to NTLM Authentication, the proxy_user and proxy_password properties are used to authenticate through NTLM negotiation.
refresh_token Property
This property specifies the refresh token received from or sent to the authorization server.
Syntax
def get_refresh_token() -> str: ... def set_refresh_token(value: str) -> None: ...
refresh_token = property(get_refresh_token, set_refresh_token)
Default Value
""
Remarks
When get_authorization is called, if the authorization server returns a refresh token along with the access token, this property will hold the refresh token. Save this value for later use.
When your access token expires, set this property to the corresponding refresh token. Then call get_authorization, and the class will use this token to retrieve a new access token. The new authorization string will be returned by the get_authorization method. No user interaction is required when refreshing an access token.
return_url Property
This property includes the URL where the user (browser) returns after authenticating.
Syntax
def get_return_url() -> str: ... def set_return_url(value: str) -> None: ...
return_url = property(get_return_url, set_return_url)
Default Value
""
Remarks
When client_profile is set to ocpApplication, this will be automatically set to the address of the local embedded web server. In that case, this property can be inspected to determine the URL where the user will be redirected, but it does not need to be set.
When calling get_authorization_url, which is common when client_profile is set to ocpWeb, set this property to the URL on your server where the user will be redirected after authenticating with the authorization server.
This property corresponds to the redirect_uri query string parameter.
server_auth_url Property
This property includes the URL of the authorization server.
Syntax
def get_server_auth_url() -> str: ... def set_server_auth_url(value: str) -> None: ...
server_auth_url = property(get_server_auth_url, set_server_auth_url)
Default Value
""
Remarks
This property specifies the URL of the authorization server used when get_authorization is called. This value is used when constructing the URL to which the user will be redirected to authenticate and grant access.
This should be specified before calling get_authorization.
server_token_url Property
This property includes the URL used to obtain the access token.
Syntax
def get_server_token_url() -> str: ... def set_server_token_url(value: str) -> None: ...
server_token_url = property(get_server_token_url, set_server_token_url)
Default Value
""
Remarks
The property specifies the URL where the grant will be exchanged for the access token. This is typically a separate HTTP endpoint on the authorization server.
This must be set before calling get_authorization.
server_user_info_url Property
The URL of the OpenID provider's user info endpoint.
Syntax
def get_server_user_info_url() -> str: ... def set_server_user_info_url(value: str) -> None: ...
server_user_info_url = property(get_server_user_info_url, set_server_user_info_url)
Default Value
""
Remarks
This property holds the URL of the OpenID provider's user info endpoint. This value is required when calling get_user_info.
This property is populated when get_discovery_doc is called.
signer_cert_encoded Property
This is the certificate (PEM/base64 encoded).
Syntax
def get_signer_cert_encoded() -> bytes: ... def set_signer_cert_encoded(value: bytes) -> None: ...
signer_cert_encoded = property(get_signer_cert_encoded, set_signer_cert_encoded)
Default Value
""
Remarks
This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The signer_cert_store and signer_cert_subject properties also may be used to specify a certificate.
When signer_cert_encoded is set, a search is initiated in the current signer_cert_store for the private key of the certificate. If the key is found, signer_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, signer_cert_subject is set to an empty string.
signer_cert_store Property
This is the name of the certificate store for the client certificate.
Syntax
def get_signer_cert_store() -> bytes: ... def set_signer_cert_store(value: bytes) -> None: ...
signer_cert_store = property(get_signer_cert_store, set_signer_cert_store)
Default Value
"MY"
Remarks
This is the name of the certificate store for the client certificate.
The signer_cert_store_type property denotes the type of the certificate store specified by signer_cert_store. If the store is password protected, specify the password in signer_cert_store_password.
signer_cert_store is used in conjunction with the signer_cert_subject property to specify client certificates. If signer_cert_store has a value, and signer_cert_subject or signer_cert_encoded is set, a search for a certificate is initiated. Please see the signer_cert_subject property for details.
Designations of certificate stores are platform-dependent.
The following are designations of the most common User and Machine certificate stores in Windows:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).
signer_cert_store_password Property
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Syntax
def get_signer_cert_store_password() -> str: ... def set_signer_cert_store_password(value: str) -> None: ...
signer_cert_store_password = property(get_signer_cert_store_password, set_signer_cert_store_password)
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.
signer_cert_store_type Property
This is the type of certificate store for this certificate.
Syntax
def get_signer_cert_store_type() -> int: ... def set_signer_cert_store_type(value: int) -> None: ...
signer_cert_store_type = property(get_signer_cert_store_type, set_signer_cert_store_type)
Default Value
0
Remarks
This is the type of certificate store for this certificate.
The class supports both public and private keys in a variety of formats. When the cstAuto value is used the class will automatically determine the type. This property can take one of the following values:
0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: this store type is not available in Java. |
1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. Note: this store type is not available in Java. |
2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or base64-encoded) representing a certificate store in PFX (PKCS12) format. |
4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. Note: this store type is only available in Java. |
5 (cstJKSBlob) | The certificate store is a string (binary or base64-encoded) representing a certificate store in Java Key Store (JKS) format. Note: this store type is only available in Java. |
6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 (cstPEMKeyBlob) | The certificate store is a string (binary or base64-encoded) that contains a private key and an optional certificate. |
8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
9 (cstPublicKeyBlob) | The certificate store is a string (binary or base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or base64-encoded) that contains an SSH-style public key. |
11 (cstP7BFile) | The certificate store is the name of a PKCS7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS7 format. |
13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). Note: this store type is only available in Java and .NET. |
22 (cstBCFKSBlob) | The certificate store is a string (binary or base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. Note: this store type is only available in Java and .NET. |
23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS11 interface.
To use a security key the necessary data must first be collected using the CertMgr class. The list_store_certificates method may be called after setting cert_store_type to cstPKCS11, cert_store_password to the PIN, and cert_store to the full path of the PKCS11 dll. The certificate information returned in the on_cert_list event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the signer_cert_store and set signer_cert_store_password to the PIN. Code Example: SSH Authentication with Security Key
|
99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
signer_cert_subject Property
This is the subject of the certificate used for client authentication.
Syntax
def get_signer_cert_subject() -> str: ... def set_signer_cert_subject(value: str) -> None: ...
signer_cert_subject = property(get_signer_cert_subject, set_signer_cert_subject)
Default Value
""
Remarks
This is the subject of the certificate used for client authentication.
This property must be set after all other certificate properites are set. When this property is set, a search is performed in the current certificate store certificate with 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 displayed below.
Field | Meaning |
CN | Common Name. This is commonly a host name like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
If a field value contains a comma it must be quoted.
signer_cert_url Property
The URL of the OpenID provider's signing certificate.
Syntax
def get_signer_cert_url() -> str: ... def set_signer_cert_url(value: str) -> None: ...
signer_cert_url = property(get_signer_cert_url, set_signer_cert_url)
Default Value
""
Remarks
This property holds the URL of the OpenID provider's signing certificate. The signing certificate is used to very the signature of the ID token returned when calling get_authorization.
When calling get_authorization either signer_cert_url or signer_cert must be specified.
This property is populated when get_discovery_doc is called.
ssl_accept_server_cert_encoded Property
This is the certificate (PEM/base64 encoded).
Syntax
def get_ssl_accept_server_cert_encoded() -> bytes: ... def set_ssl_accept_server_cert_encoded(value: bytes) -> None: ...
ssl_accept_server_cert_encoded = property(get_ssl_accept_server_cert_encoded, set_ssl_accept_server_cert_encoded)
Default Value
""
Remarks
This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The ssl_accept_server_cert_store and ssl_accept_server_cert_subject properties also may be used to specify a certificate.
When ssl_accept_server_cert_encoded is set, a search is initiated in the current ssl_accept_server_cert_store for the private key of the certificate. If the key is found, ssl_accept_server_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_accept_server_cert_subject is set to an empty string.
ssl_cert_encoded Property
This is the certificate (PEM/base64 encoded).
Syntax
def get_ssl_cert_encoded() -> bytes: ... def set_ssl_cert_encoded(value: bytes) -> None: ...
ssl_cert_encoded = property(get_ssl_cert_encoded, set_ssl_cert_encoded)
Default Value
""
Remarks
This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The ssl_cert_store and ssl_cert_subject properties also may be used to specify a certificate.
When ssl_cert_encoded is set, a search is initiated in the current ssl_cert_store for the private key of the certificate. If the key is found, ssl_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_cert_subject is set to an empty string.
ssl_cert_store Property
This is the name of the certificate store for the client certificate.
Syntax
def get_ssl_cert_store() -> bytes: ... def set_ssl_cert_store(value: bytes) -> None: ...
ssl_cert_store = property(get_ssl_cert_store, set_ssl_cert_store)
Default Value
"MY"
Remarks
This is the name of the certificate store for the client certificate.
The ssl_cert_store_type property denotes the type of the certificate store specified by ssl_cert_store. If the store is password protected, specify the password in ssl_cert_store_password.
ssl_cert_store is used in conjunction with the ssl_cert_subject property to specify client certificates. If ssl_cert_store has a value, and ssl_cert_subject or ssl_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_cert_subject property for details.
Designations of certificate stores are platform-dependent.
The following are designations of the most common User and Machine certificate stores in Windows:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).
ssl_cert_store_password Property
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Syntax
def get_ssl_cert_store_password() -> str: ... def set_ssl_cert_store_password(value: str) -> None: ...
ssl_cert_store_password = property(get_ssl_cert_store_password, set_ssl_cert_store_password)
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.
ssl_cert_store_type Property
This is the type of certificate store for this certificate.
Syntax
def get_ssl_cert_store_type() -> int: ... def set_ssl_cert_store_type(value: int) -> None: ...
ssl_cert_store_type = property(get_ssl_cert_store_type, set_ssl_cert_store_type)
Default Value
0
Remarks
This is the type of certificate store for this certificate.
The class supports both public and private keys in a variety of formats. When the cstAuto value is used the class will automatically determine the type. This property can take one of the following values:
0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: this store type is not available in Java. |
1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. Note: this store type is not available in Java. |
2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or base64-encoded) representing a certificate store in PFX (PKCS12) format. |
4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. Note: this store type is only available in Java. |
5 (cstJKSBlob) | The certificate store is a string (binary or base64-encoded) representing a certificate store in Java Key Store (JKS) format. Note: this store type is only available in Java. |
6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 (cstPEMKeyBlob) | The certificate store is a string (binary or base64-encoded) that contains a private key and an optional certificate. |
8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
9 (cstPublicKeyBlob) | The certificate store is a string (binary or base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or base64-encoded) that contains an SSH-style public key. |
11 (cstP7BFile) | The certificate store is the name of a PKCS7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS7 format. |
13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). Note: this store type is only available in Java and .NET. |
22 (cstBCFKSBlob) | The certificate store is a string (binary or base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. Note: this store type is only available in Java and .NET. |
23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS11 interface.
To use a security key the necessary data must first be collected using the CertMgr class. The list_store_certificates method may be called after setting cert_store_type to cstPKCS11, cert_store_password to the PIN, and cert_store to the full path of the PKCS11 dll. The certificate information returned in the on_cert_list event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the ssl_cert_store and set ssl_cert_store_password to the PIN. Code Example: SSH Authentication with Security Key
|
99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
ssl_cert_subject Property
This is the subject of the certificate used for client authentication.
Syntax
def get_ssl_cert_subject() -> str: ... def set_ssl_cert_subject(value: str) -> None: ...
ssl_cert_subject = property(get_ssl_cert_subject, set_ssl_cert_subject)
Default Value
""
Remarks
This is the subject of the certificate used for client authentication.
This property must be set after all other certificate properites are set. When this property is set, a search is performed in the current certificate store certificate with 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 displayed below.
Field | Meaning |
CN | Common Name. This is commonly a host name like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
If a field value contains a comma it must be quoted.
ssl_provider Property
This specifies the SSL/TLS implementation to use.
Syntax
def get_ssl_provider() -> int: ... def set_ssl_provider(value: int) -> None: ...
ssl_provider = property(get_ssl_provider, set_ssl_provider)
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:
0 (sslpAutomatic - default) | Automatically selects the appropriate implementation. |
1 (sslpPlatform) | Uses the platform/system implementation. |
2 (sslpInternal) | Uses the internal implementation. |
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.
ssl_server_cert_encoded Property
This is the certificate (PEM/base64 encoded).
Syntax
def get_ssl_server_cert_encoded() -> bytes: ...
ssl_server_cert_encoded = property(get_ssl_server_cert_encoded, None)
Default Value
""
Remarks
This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The ssl_server_cert_store and ssl_server_cert_subject properties also may be used to specify a certificate.
When ssl_server_cert_encoded is set, a search is initiated in the current ssl_server_cert_store for the private key of the certificate. If the key is found, ssl_server_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_server_cert_subject is set to an empty string.
This property is read-only.
state Property
Opaque value used to maintain state between the request and response.
Syntax
def get_state() -> str: ... def set_state(value: str) -> None: ...
state = property(get_state, set_state)
Default Value
""
Remarks
This property optionally holds a string value which will be returned by the authorization server with the response.
Any value may be specified here and it will be returned exactly as it was sent. This can be used to maintain state within the application, and also may be used for security purposes (for instance to prevent Cross-Site Request Forgery). The contents of this property are treated as an opaque value.
When client_profile is set to ocpApplication the on_return_url event provides the state value returned by the authorization server.
timeout Property
A timeout for the class.
Syntax
def get_timeout() -> int: ... def set_timeout(value: int) -> None: ...
timeout = property(get_timeout, set_timeout)
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 do_events to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not "freeze" and remains responsive.
If timeout expires, and the operation is not yet complete, the class fails with an error.
Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by timeout seconds when any amount of data is successfully sent or received.
The default value for the timeout property is 60 seconds.
transferred_data Property
This property includes the contents of the last response from the server.
Syntax
def get_transferred_data() -> bytes: ...
transferred_data = property(get_transferred_data, None)
Default Value
""
Remarks
This property contains the contents of the last response from the server.
TransferredDataLimit controls the maximum amount of data accumulated in transferred_data (by default, there is no limit).
This property is read-only.
transferred_headers Property
This property includes the full set of headers as received from the server.
Syntax
def get_transferred_headers() -> str: ...
transferred_headers = property(get_transferred_headers, None)
Default Value
""
Remarks
This property returns the complete set of raw headers as received from the server.
The on_header event shows the individual headers as parsed by the class.
This property is read-only.
use_pkce Property
This property specifies if Proof Key for Code Exchange (PKCE) should be used.
Syntax
def get_use_pkce() -> bool: ... def set_use_pkce(value: bool) -> None: ...
use_pkce = property(get_use_pkce, set_use_pkce)
Default Value
FALSE
Remarks
If specified, Proof Key for Code Exchange (PKCE) defined by RFC 7636 will be used when get_authorization is called. This applies when using the Authorization Code grant_type. The PKCEChallengeEncoding configuration setting can be used to control the code challenge method that will be used.
user_details_addr_country Property
This property holds the country name portion of the user's address.
Syntax
def get_user_details_addr_country() -> str: ...
user_details_addr_country = property(get_user_details_addr_country, None)
Default Value
""
Remarks
This property holds the country name portion of the user's address.
This property is read-only.
user_details_addr_formatted Property
This property holds the full mailing address of the user, formatted for display or use on a mailing label.
Syntax
def get_user_details_addr_formatted() -> str: ...
user_details_addr_formatted = property(get_user_details_addr_formatted, None)
Default Value
""
Remarks
This property holds the full mailing address of the user, formatted for display or use on a mailing label. This value may contain multiple lines.
This property is read-only.
user_details_addr_locality Property
This property holds the city or locality portion of the user's address.
Syntax
def get_user_details_addr_locality() -> str: ...
user_details_addr_locality = property(get_user_details_addr_locality, None)
Default Value
""
Remarks
This property holds the city or locality portion of the user's address.
This property is read-only.
user_details_addr_postal_code Property
This property holds the zip code or postal code portion of the user's address.
Syntax
def get_user_details_addr_postal_code() -> str: ...
user_details_addr_postal_code = property(get_user_details_addr_postal_code, None)
Default Value
""
Remarks
This property holds the zip code or postal code portion of the user's address.
This property is read-only.
user_details_addr_region Property
This property holds the state, province, prefecture, or region portion of the user's address.
Syntax
def get_user_details_addr_region() -> str: ...
user_details_addr_region = property(get_user_details_addr_region, None)
Default Value
""
Remarks
This property holds the state, province, prefecture, or region portion of the user's address.
This property is read-only.
user_details_addr_street_addr Property
This property holds the street address portion of the user's address.
Syntax
def get_user_details_addr_street_addr() -> str: ...
user_details_addr_street_addr = property(get_user_details_addr_street_addr, None)
Default Value
""
Remarks
This property holds the street address portion of the user's address. This is the full street address which may include house number, street name, post office box, and multi-line extended street information. This value may contain multiple lines.
This property is read-only.
user_details_audiences Property
This property contains a comma separated list of audiences for which the user information is intended.
Syntax
def get_user_details_audiences() -> str: ...
user_details_audiences = property(get_user_details_audiences, None)
Default Value
""
Remarks
This property contains a comma separated list of audiences for which the user information is intended.
This property is read-only.
user_details_birthday Property
This property contains the user's birthday.
Syntax
def get_user_details_birthday() -> str: ...
user_details_birthday = property(get_user_details_birthday, None)
Default Value
""
Remarks
This property contains the user's birthday. The format of the value is YYYY-MM-DD or YYYY. The year may be 0000 to indicate it was omitted.
This property is read-only.
user_details_email Property
This property contains the user's preferred email address.
Syntax
def get_user_details_email() -> str: ...
user_details_email = property(get_user_details_email, None)
Default Value
""
Remarks
This property contains the user's preferred email address.
This property is read-only.
user_details_email_verified Property
This property indicates whether the user's email address has been verified.
Syntax
def get_user_details_email_verified() -> bool: ...
user_details_email_verified = property(get_user_details_email_verified, None)
Default Value
FALSE
Remarks
This property indicates whether the user's email address has been verified. To be considered verified the end-user must prove the email address was under the user's control at the time of verification.
This property is read-only.
user_details_first_name Property
This property holds the first name of the user.
Syntax
def get_user_details_first_name() -> str: ...
user_details_first_name = property(get_user_details_first_name, None)
Default Value
""
Remarks
This property holds the first name of the user. If multiple names are present they are space separated.
This property is read-only.
user_details_gender Property
This property holds the user's gender.
Syntax
def get_user_details_gender() -> str: ...
user_details_gender = property(get_user_details_gender, None)
Default Value
""
Remarks
This property holds the user's gender. Defined values are male and female but other values may also be used.
This property is read-only.
user_details_issuer Property
This property contains the identifier of the issuer who issued the ID token.
Syntax
def get_user_details_issuer() -> str: ...
user_details_issuer = property(get_user_details_issuer, None)
Default Value
""
Remarks
This property contains the identifier of the issuer who issued the ID token.
This property is read-only.
user_details_last_name Property
This property holds the last name of the user.
Syntax
def get_user_details_last_name() -> str: ...
user_details_last_name = property(get_user_details_last_name, None)
Default Value
""
Remarks
This property holds the last name of the user. If multiple names are present they are space separated.
This property is read-only.
user_details_locale Property
This property holds the end user's locale.
Syntax
def get_user_details_locale() -> str: ...
user_details_locale = property(get_user_details_locale, None)
Default Value
""
Remarks
This property holds the end user's locale. This is represented as a BCP47 (RFC 5646) language tag. For instance en-US or en_US.
This property is read-only.
user_details_middle_name Property
This property holds the middle name of the user.
Syntax
def get_user_details_middle_name() -> str: ...
user_details_middle_name = property(get_user_details_middle_name, None)
Default Value
""
Remarks
This property holds the middle name of the user. If multiple names are present they are space separated.
This property is read-only.
user_details_name Property
This property contains the user's full name in displayable form including all name parts.
Syntax
def get_user_details_name() -> str: ...
user_details_name = property(get_user_details_name, None)
Default Value
""
Remarks
This property contains the user's full name in displayable form including all name parts. This may include titles and suffixes.
This property is read-only.
user_details_nickname Property
This property holds the casual name of the user.
Syntax
def get_user_details_nickname() -> str: ...
user_details_nickname = property(get_user_details_nickname, None)
Default Value
""
Remarks
This property holds the casual name of the user. This may or may not be the same as user_details_first_name.
This property is read-only.
user_details_phone_number Property
This property holds the user's phone number.
Syntax
def get_user_details_phone_number() -> str: ...
user_details_phone_number = property(get_user_details_phone_number, None)
Default Value
""
Remarks
This property holds the user's phone number. This may be in E.164 format, for instance +1 (425) 555-1212. If an extension is present it may be represented according to RFC 3966. For instance: +1 (604) 555-1234;ext=5678.
This property is read-only.
user_details_phone_number_verified Property
This property indicates whether the user's phone number has been verified.
Syntax
def get_user_details_phone_number_verified() -> bool: ...
user_details_phone_number_verified = property(get_user_details_phone_number_verified, None)
Default Value
FALSE
Remarks
This property indicates whether the user's phone number has been verified. To be considered verified the end-user must prove the phone number was under the user's control at the time of verification.
This property is read-only.
user_details_picture_url Property
This property holds the URL of the user's profile picture.
Syntax
def get_user_details_picture_url() -> str: ...
user_details_picture_url = property(get_user_details_picture_url, None)
Default Value
""
Remarks
This property holds the URL of the user's profile picture.
This property is read-only.
user_details_preferred_username Property
This property holds the shorthand name by which the end-user wishes to be referred.
Syntax
def get_user_details_preferred_username() -> str: ...
user_details_preferred_username = property(get_user_details_preferred_username, None)
Default Value
""
Remarks
This property holds the shorthand name by which the end-user wishes to be referred.
This property is read-only.
user_details_profile_url Property
This property holds the URL of the user's profile page.
Syntax
def get_user_details_profile_url() -> str: ...
user_details_profile_url = property(get_user_details_profile_url, None)
Default Value
""
Remarks
This property holds the URL of the user's profile page.
This property is read-only.
user_details_subject Property
This property holds the subject identifier of the token.
Syntax
def get_user_details_subject() -> str: ...
user_details_subject = property(get_user_details_subject, None)
Default Value
""
Remarks
This property holds the subject identifier of the token.
This property is read-only.
user_details_token_auth_time Property
This property holds the time when authentication occurred.
Syntax
def get_user_details_token_auth_time() -> int: ...
user_details_token_auth_time = property(get_user_details_token_auth_time, None)
Default Value
0
Remarks
This property holds the time when authentication occurred.
The time value is a number representing the number of seconds from 1970-01-01T0:0:0Z as measured in UTC until the date/time.
This property is read-only.
user_details_token_exp_time Property
This property holds the expiration time of the token.
Syntax
def get_user_details_token_exp_time() -> int: ...
user_details_token_exp_time = property(get_user_details_token_exp_time, None)
Default Value
0
Remarks
This property holds the expiration time of the token.
The time value is a number representing the number of seconds from 1970-01-01T0:0:0Z as measured in UTC until the date/time.
This property is read-only.
user_details_token_issued_at Property
This property holds the time when the token was issued.
Syntax
def get_user_details_token_issued_at() -> int: ...
user_details_token_issued_at = property(get_user_details_token_issued_at, None)
Default Value
0
Remarks
This property holds the time when the token was issued.
The time value is a number representing the number of seconds from 1970-01-01T0:0:0Z as measured in UTC until the date/time.
This property is read-only.
user_details_updated_at Property
This property holds the time when the user's information was last updated.
Syntax
def get_user_details_updated_at() -> int: ...
user_details_updated_at = property(get_user_details_updated_at, None)
Default Value
0
Remarks
This property holds the time when the user's information was last updated.
The time value is a number representing the number of seconds from 1970-01-01T0:0:0Z as measured in UTC until the date/time.
This property is read-only.
user_details_website Property
This property holds the URL of the user's website.
Syntax
def get_user_details_website() -> str: ...
user_details_website = property(get_user_details_website, None)
Default Value
""
Remarks
This property holds the URL of the user's website.
This property is read-only.
user_details_zone_info Property
This property holds the user's time zone.
Syntax
def get_user_details_zone_info() -> str: ...
user_details_zone_info = property(get_user_details_zone_info, None)
Default Value
""
Remarks
This property holds the user's time zone. For instance: America/Los_Angeles.
This property is read-only.
web_server_port Property
This property includes the local port on which the embedded web server listens.
Syntax
def get_web_server_port() -> int: ... def set_web_server_port(value: int) -> None: ...
web_server_port = property(get_web_server_port, set_web_server_port)
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.
web_server_ssl_cert_store Property
This is the name of the certificate store for the client certificate.
Syntax
def get_web_server_ssl_cert_store() -> bytes: ... def set_web_server_ssl_cert_store(value: bytes) -> None: ...
web_server_ssl_cert_store = property(get_web_server_ssl_cert_store, set_web_server_ssl_cert_store)
Default Value
"MY"
Remarks
This is the name of the certificate store for the client certificate.
The web_server_ssl_cert_store_type property denotes the type of the certificate store specified by web_server_ssl_cert_store. If the store is password protected, specify the password in web_server_ssl_cert_store_password.
web_server_ssl_cert_store is used in conjunction with the web_server_ssl_cert_subject property to specify client certificates. If web_server_ssl_cert_store has a value, and web_server_ssl_cert_subject or web_server_ssl_cert_encoded is set, a search for a certificate is initiated. Please see the web_server_ssl_cert_subject property for details.
Designations of certificate stores are platform-dependent.
The following are designations of the most common User and Machine certificate stores in Windows:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).
web_server_ssl_cert_store_password Property
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Syntax
def get_web_server_ssl_cert_store_password() -> str: ... def set_web_server_ssl_cert_store_password(value: str) -> None: ...
web_server_ssl_cert_store_password = property(get_web_server_ssl_cert_store_password, set_web_server_ssl_cert_store_password)
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.
web_server_ssl_cert_store_type Property
This is the type of certificate store for this certificate.
Syntax
def get_web_server_ssl_cert_store_type() -> int: ... def set_web_server_ssl_cert_store_type(value: int) -> None: ...
web_server_ssl_cert_store_type = property(get_web_server_ssl_cert_store_type, set_web_server_ssl_cert_store_type)
Default Value
0
Remarks
This is the type of certificate store for this certificate.
The class supports both public and private keys in a variety of formats. When the cstAuto value is used the class will automatically determine the type. This property can take one of the following values:
0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: this store type is not available in Java. |
1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. Note: this store type is not available in Java. |
2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or base64-encoded) representing a certificate store in PFX (PKCS12) format. |
4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. Note: this store type is only available in Java. |
5 (cstJKSBlob) | The certificate store is a string (binary or base64-encoded) representing a certificate store in Java Key Store (JKS) format. Note: this store type is only available in Java. |
6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 (cstPEMKeyBlob) | The certificate store is a string (binary or base64-encoded) that contains a private key and an optional certificate. |
8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
9 (cstPublicKeyBlob) | The certificate store is a string (binary or base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or base64-encoded) that contains an SSH-style public key. |
11 (cstP7BFile) | The certificate store is the name of a PKCS7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS7 format. |
13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). Note: this store type is only available in Java and .NET. |
22 (cstBCFKSBlob) | The certificate store is a string (binary or base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. Note: this store type is only available in Java and .NET. |
23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS11 interface.
To use a security key the necessary data must first be collected using the CertMgr class. The list_store_certificates method may be called after setting cert_store_type to cstPKCS11, cert_store_password to the PIN, and cert_store to the full path of the PKCS11 dll. The certificate information returned in the on_cert_list event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the web_server_ssl_cert_store and set web_server_ssl_cert_store_password to the PIN. Code Example: SSH Authentication with Security Key
|
99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
web_server_ssl_cert_subject Property
This is the subject of the certificate used for client authentication.
Syntax
def get_web_server_ssl_cert_subject() -> str: ... def set_web_server_ssl_cert_subject(value: str) -> None: ...
web_server_ssl_cert_subject = property(get_web_server_ssl_cert_subject, set_web_server_ssl_cert_subject)
Default Value
""
Remarks
This is the subject of the certificate used for client authentication.
This property must be set after all other certificate properites are set. When this property is set, a search is performed in the current certificate store certificate with 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 displayed below.
Field | Meaning |
CN | Common Name. This is commonly a host name like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
If a field value contains a comma it must be quoted.
web_server_ssl_enabled Property
This property specifies whether the web server requires Secure Sockets Layer (SSL) connections.
Syntax
def get_web_server_ssl_enabled() -> bool: ... def set_web_server_ssl_enabled(value: bool) -> None: ...
web_server_ssl_enabled = property(get_web_server_ssl_enabled, set_web_server_ssl_enabled)
Default Value
FALSE
Remarks
This setting specifies whether the embedded web server uses a Secure Sockets Layer (SSL). If set to True, web_server_ssl_cert is required and the server will accept only SSL connections. If set to False, only plaintext connects are supported.
add_cookie Method
This method adds a cookie and the corresponding value to the outgoing request headers.
Syntax
def add_cookie(cookie_name: str, cookie_value: str) -> None: ...
Remarks
This property adds a cookie and the corresponding value to the outgoing request headers. Please refer to the cookies property for more information on cookies and how they are managed.
add_param Method
This method adds a name-value pair to the query string parameters of outgoing request.
Syntax
def add_param(param_name: str, param_value: str) -> None: ...
Remarks
This method can be used to add query string parameters to the outgoing request. One common use for this method would be to add the state parameter to the request, which can be used when the client_profile is ocpWeb to add user-defined data. The authorization server will include the state parameter in the response and will be available in the post back to your server, which will allow you to maintain state in your application.
config Method
Sets or retrieves a configuration setting.
Syntax
def config(configuration_string: str) -> str: ...
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.
do_events Method
Processes events from the internal message queue.
Syntax
def do_events() -> None: ...
Remarks
When do_events is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns.
get_authorization Method
Gets the authorization string required to access the protected resource.
Syntax
def get_authorization() -> str: ...
Remarks
get_authorization performs several operations automatically depending on the value of client_profile. Please see the introduction section for the OpenID class for a detailed overview of the typical scenarios.
After authorization is complete user_details will be populated with the claims parsed from the ID token. This method also returns an authorization string. The authorization string grants access to additional resources as requested via the authorization_scope property. If access to another resource was requested the access token returned here may be set in the Authorization property of any other class (or passed as the value of the HTTP Authorization header).
get_user_info may be called after calling this method.
The following properties are applicable when calling this method:
- client_id (required)
- client_secret (required)
- server_auth_url (required - populated by get_discovery_doc.)
- server_token_url (required - populated by get_discovery_doc.)
- signer_cert_url (conditional - populated by get_discovery_doc. Required if signer_cert is not set.)
- signer_cert (conditional - required if signer_cert_url is not set.)
- authorization_scope
- client_profile
- grant_type
- params
- refresh_token
- return_url
- state
- timeout
- Display
- Prompt
- IDTokenHint
- LoginHint
- ResponseType
get_authorization_url Method
This method builds and returns the URL to which the user should be redirected for authorization.
Syntax
def get_authorization_url() -> str: ...
Remarks
When this method is called, the class will return the URL used for authorization. The class will not make any connections, but instead it will return the URL to you so that you may redirect the user to this location. This is useful when client_profile is set to ocpWeb. Before calling this method, set the following:
get_discovery_doc Method
Gets the OpenID Discovery Document.
Syntax
def get_discovery_doc(url: str) -> None: ...
Remarks
This method gets the OpenID Connect Discovery Document specified by the URL parameter and parses the response. The discover 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 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 get_discovery_doc before calling get_authorization to populate the class properties with information required to complete the authorization. The retrieved information includes endpoint URLs as well as the OpenID public certificates used to verify the signature on the ID token. After calling this method the following properties are populated:
The above values may be stored, and later populated from the stored values, to avoid the requirement of calling get_discovery_doc on subsequent authorization requests.
The following discovery document fields are populated after get_discovery_doc returns:
- discovery_doc_details_authorization_url
- discovery_doc_details_claims_param_supported
- discovery_doc_details_issuer
- discovery_doc_details_signer_cert_url
- discovery_doc_details_registration_url
- discovery_doc_details_service_docs_url
- discovery_doc_details_supported_claims
- discovery_doc_details_supported_displays
- discovery_doc_details_supported_grant_types
- discovery_doc_details_supported_response_types
- discovery_doc_details_supported_scopes
- discovery_doc_details_token_url
- discovery_doc_details_user_info_url
To access values not automatically parsed by the class the XPath configuration setting may be set to retrieve a specific value. Alternatively the RawJSON setting returns the entire JSON document which may be parsed separately.
get_param Method
This method gets a specific parameter from a query string.
Syntax
def get_param(param_name: str) -> str: ...
Remarks
This method can be used to get a specific parameter from a query string.
For example, when using the ocpApplication profile, this method can be used in the on_return_url event to query the parameters that are returned from the authorization server. Then, it can be called after get_authorization completes to query the parameters that the token server responded with.
string authorizationString = oauth.GetAuthorization();
string stateValue = oauth.GetParam("state");
get_user_info Method
Retrieves claims about the user.
Syntax
def get_user_info() -> None: ...
Remarks
This method retrieves claims about the user. Before calling get_user_info method a successful call to get_authorization must be made. The access token returned by get_authorization is used by the OpenID provider at server_user_info_url to identify the user for which claims are being retrieved.
When this method is called the class requests the claims about the user from the server_user_info_url. The resulting claims are available in the UserDetail* properties.
Note: The get_user_info method will populate the UserDetail* properties with the claims returned in the ID token during the authorization process. This method may not need to be called in order to access the desired claims about the user.
openid.GetUserInfo();
// ... use the user info in the remainder of your application ...
interrupt Method
Interrupt the current method.
Syntax
def interrupt() -> None: ...
Remarks
If there is no method in progress, interrupt simply returns, doing nothing.
reset Method
Reset the class.
Syntax
def reset() -> None: ...
Remarks
This method will reset the class's properties to their default values.
start_web_server Method
This method starts the embedded web server.
Syntax
def start_web_server() -> None: ...
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 get_authorization is called. You may decide, however, to start the web server manually before calling get_authorization. When called, this method will also populate return_url with the address of the embedded server.
stop_web_server Method
This method stops the embedded web server.
Syntax
def stop_web_server() -> None: ...
Remarks
This method stops the embedded web server. Under normal circumstances, the web server will be stopped automatically during the authorization process when get_authorization 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.
on_connected Event
This event is fired immediately after a connection completes (or fails).
Syntax
class OpenIDConnectedEventParams(object): @property def status_code() -> int: ... @property def description() -> str: ... # In class OpenID: @property def on_connected() -> Callable[[OpenIDConnectedEventParams], None]: ... @on_connected.setter def on_connected(event_hook: Callable[[OpenIDConnectedEventParams], None]) -> None: ...
Remarks
If the connection is made normally, StatusCode is 0 and Description is "OK".
If the connection fails, StatusCode has the error code returned by the Transmission Control Protocol (TCP)/IP stack. Description contains a description of this code. The value of StatusCode is equal to the value of the error.
Please refer to the Error Codes section for more information.
on_connection_status Event
This event is fired to indicate changes in the connection state.
Syntax
class OpenIDConnectionStatusEventParams(object): @property def connection_event() -> str: ... @property def status_code() -> int: ... @property def description() -> str: ... # In class OpenID: @property def on_connection_status() -> Callable[[OpenIDConnectionStatusEventParams], None]: ... @on_connection_status.setter def on_connection_status(event_hook: Callable[[OpenIDConnectionStatusEventParams], None]) -> None: ...
Remarks
The on_connection_status event is fired when the connection state changes: for example, completion of a firewall or proxy connection or completion of a security handshake.
The ConnectionEvent parameter indicates the type of connection event. Values may include the following:
Firewall connection complete. | |
Secure Sockets Layer (SSL) or S/Shell handshake complete (where applicable). | |
Remote host connection complete. | |
Remote host disconnected. | |
SSL or S/Shell connection broken. | |
Firewall host disconnected. |
on_disconnected Event
This event is fired when a connection is closed.
Syntax
class OpenIDDisconnectedEventParams(object): @property def status_code() -> int: ... @property def description() -> str: ... # In class OpenID: @property def on_disconnected() -> Callable[[OpenIDDisconnectedEventParams], None]: ... @on_disconnected.setter def on_disconnected(event_hook: Callable[[OpenIDDisconnectedEventParams], None]) -> None: ...
Remarks
If the connection is broken normally, StatusCode is 0 and Description is "OK".
If the connection is broken for any other reason, StatusCode has the error code returned by the Transmission Control Protocol (TCP/IP) subsystem. Description contains a description of this code. The value of StatusCode is equal to the value of the TCP/IP error.
Please refer to the Error Codes section for more information.
on_end_transfer Event
This event is fired when a document finishes transferring.
Syntax
class OpenIDEndTransferEventParams(object): @property def direction() -> int: ... # In class OpenID: @property def on_end_transfer() -> Callable[[OpenIDEndTransferEventParams], None]: ... @on_end_transfer.setter def on_end_transfer(event_hook: Callable[[OpenIDEndTransferEventParams], None]) -> None: ...
Remarks
The on_end_transfer event is fired first when the client finishes sending data to the server (in a POST or PUT request) and then when the document text finishes transferring from the server to the local host.
The Direction parameter shows whether the client (0) or the server (1) is sending the data.
on_error Event
Information about errors during data delivery.
Syntax
class OpenIDErrorEventParams(object): @property def error_code() -> int: ... @property def description() -> str: ... # In class OpenID: @property def on_error() -> Callable[[OpenIDErrorEventParams], None]: ... @on_error.setter def on_error(event_hook: Callable[[OpenIDErrorEventParams], None]) -> None: ...
Remarks
The on_error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.
ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.
on_header Event
This event is fired every time a header line comes in.
Syntax
class OpenIDHeaderEventParams(object): @property def field() -> str: ... @property def value() -> str: ... # In class OpenID: @property def on_header() -> Callable[[OpenIDHeaderEventParams], None]: ... @on_header.setter def on_header(event_hook: Callable[[OpenIDHeaderEventParams], None]) -> None: ...
Remarks
The Field parameter contains the name of the HTTP header (which is the same as it is delivered). The Value parameter contains the header contents.
If the header line being retrieved is a continuation header line, then the Field parameter contains "" (empty string).
on_launch_browser Event
This event fires before launching a browser with the authorization URL.
Syntax
class OpenIDLaunchBrowserEventParams(object): @property def url() -> str: ... @url.setter def url(value) -> None: ... @property def command() -> str: ... @command.setter def command(value) -> None: ... # In class OpenID: @property def on_launch_browser() -> Callable[[OpenIDLaunchBrowserEventParams], None]: ... @on_launch_browser.setter def on_launch_browser(event_hook: Callable[[OpenIDLaunchBrowserEventParams], None]) -> None: ...
Remarks
When the client_profile property is set to ocpApplication and get_authorization 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
on_log Event
This event fires once for each log message.
Syntax
class OpenIDLogEventParams(object): @property def log_level() -> int: ... @property def message() -> str: ... @property def log_type() -> str: ... # In class OpenID: @property def on_log() -> Callable[[OpenIDLogEventParams], None]: ... @on_log.setter def on_log(event_hook: Callable[[OpenIDLogEventParams], None]) -> None: ...
Remarks
This event fires 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:
0 (None) | No events are logged. |
1 (Info - default) | Informational events are logged. |
2 (Verbose) | Detailed data are logged. |
3 (Debug) | Debug data are logged. |
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"
on_redirect Event
This event is fired when a redirection is received from the server.
Syntax
class OpenIDRedirectEventParams(object): @property def location() -> str: ... @property def accept() -> bool: ... @accept.setter def accept(value) -> None: ... # In class OpenID: @property def on_redirect() -> Callable[[OpenIDRedirectEventParams], None]: ... @on_redirect.setter def on_redirect(event_hook: Callable[[OpenIDRedirectEventParams], None]) -> None: ...
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 follow_redirects property.
on_return_url Event
Fires when the user is redirected to the embedded web server.
Syntax
class OpenIDReturnURLEventParams(object): @property def url_path() -> str: ... @property def query_string() -> str: ... @property def state() -> str: ... @property def response_headers() -> str: ... @response_headers.setter def response_headers(value) -> None: ... @property def response_body() -> str: ... @response_body.setter def response_body(value) -> None: ... # In class OpenID: @property def on_return_url() -> Callable[[OpenIDReturnURLEventParams], None]: ... @on_return_url.setter def on_return_url(event_hook: Callable[[OpenIDReturnURLEventParams], None]) -> None: ...
Remarks
When client_profile is set to ocpApplication and the embedded web server is used (default), this event will fire when the user is redirected from authorization server back to the local embedded web server. The event provides an opportunity to set the ResponseHeaders and ResponseBody and provide a custom response that the user will see in their browser.
URLPath and QueryString are informational parameters that show the values sent by the authorization server.
State holds the value of the state parameter that was originally sent with the authorization request. This may be used to maintain state between the request and response. See state for more details.
on_set_cookie Event
This event is fired for every cookie set by the server.
Syntax
class OpenIDSetCookieEventParams(object): @property def name() -> str: ... @property def value() -> str: ... @property def expires() -> str: ... @property def domain() -> str: ... @property def path() -> str: ... @property def secure() -> bool: ... # In class OpenID: @property def on_set_cookie() -> Callable[[OpenIDSetCookieEventParams], None]: ... @on_set_cookie.setter def on_set_cookie(event_hook: Callable[[OpenIDSetCookieEventParams], None]) -> None: ...
Remarks
The on_set_cookie event is fired for every Set-Cookie: header received from the HTTP server.
The Name parameter contains the name of the cookie, with the corresponding value supplied in the Value parameter.
The Expires parameter contains an expiration time for the cookie (if provided by the server). The time format used is "Weekday, DD-Mon-YY HH:MM:SS GMT". If the server does not provide an expiration time, the Expires parameter will be an empty string. In this case, the convention is to drop the cookie at the end of the session.
The Domain parameter contains a domain name to limit the cookie to (if provided by the server). If the server does not provide a domain name, the Domain parameter will be an empty string. The convention in this case is to use the server specified in the URL (url_server) as the cookie domain.
The Path parameter contains a path name to limit the cookie to (if provided by the server). If the server does not provide a cookie path, the Path parameter will be an empty string. The convention in this case is to use the path specified in the URL (url_path) as the cookie path.
The Secure parameter specifies whether the cookie is secure. If the value of this parameter is True, the cookie value must be submitted only through a secure (HTTPS) connection.
on_ssl_server_authentication Event
Fired after the server presents its certificate to the client.
Syntax
class OpenIDSSLServerAuthenticationEventParams(object): @property def cert_encoded() -> bytes: ... @property def cert_subject() -> str: ... @property def cert_issuer() -> str: ... @property def status() -> str: ... @property def accept() -> bool: ... @accept.setter def accept(value) -> None: ... # In class OpenID: @property def on_ssl_server_authentication() -> Callable[[OpenIDSSLServerAuthenticationEventParams], None]: ... @on_ssl_server_authentication.setter def on_ssl_server_authentication(event_hook: Callable[[OpenIDSSLServerAuthenticationEventParams], None]) -> None: ...
Remarks
This event is where the client can decide whether to continue with the connection process or not. 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 to continue or not.
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.
on_ssl_status Event
Shows the progress of the secure connection.
Syntax
class OpenIDSSLStatusEventParams(object): @property def message() -> str: ... # In class OpenID: @property def on_ssl_status() -> Callable[[OpenIDSSLStatusEventParams], None]: ... @on_ssl_status.setter def on_ssl_status(event_hook: Callable[[OpenIDSSLStatusEventParams], None]) -> None: ...
Remarks
The event is fired for informational and logging purposes only. Used to track the progress of the connection.
on_start_transfer Event
This event is fired when a document starts transferring (after the headers).
Syntax
class OpenIDStartTransferEventParams(object): @property def direction() -> int: ... # In class OpenID: @property def on_start_transfer() -> Callable[[OpenIDStartTransferEventParams], None]: ... @on_start_transfer.setter def on_start_transfer(event_hook: Callable[[OpenIDStartTransferEventParams], None]) -> None: ...
Remarks
The on_start_transfer event is fired first when the client starts sending data to the server (in a POST or PUT request) and then when the document text starts transferring from the server to the local host.
The Direction parameter shows whether the client (0) or the server (1) is sending the data.
on_status Event
This event is fired when the HTTP status line is received from the server.
Syntax
class OpenIDStatusEventParams(object): @property def http_version() -> str: ... @property def status_code() -> int: ... @property def description() -> str: ... # In class OpenID: @property def on_status() -> Callable[[OpenIDStatusEventParams], None]: ... @on_status.setter def on_status(event_hook: Callable[[OpenIDStatusEventParams], None]) -> None: ...
Remarks
HTTPVersion is a string containing the HTTP version string as returned from the server (e.g., "1.1").
StatusCode contains the HTTP status code (e.g., 200), and Description the associated message returned by the server (e.g., "OK").
on_transfer Event
This event is fired while a document transfers (delivers document).
Syntax
class OpenIDTransferEventParams(object): @property def direction() -> int: ... @property def bytes_transferred() -> int: ... @property def percent_done() -> int: ... @property def text() -> bytes: ... # In class OpenID: @property def on_transfer() -> Callable[[OpenIDTransferEventParams], None]: ... @on_transfer.setter def on_transfer(event_hook: Callable[[OpenIDTransferEventParams], None]) -> None: ...
Remarks
The Text parameter contains the portion of the document text being received. It is empty if data are being posted to the server.
The BytesTransferred parameter contains the number of bytes transferred in this Direction since the beginning of the document text (excluding HTTP response headers).
The Direction parameter shows whether the client (0) or the server (1) is sending the data.
The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.
Note: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.
OpenID Config Settings
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.OpenID Config Settings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Display:
The requested display options to present to the end user.This optional setting specifies the display options that the authorization server should display to the user. Possible values are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
IDToken: The raw ID token returned after authorization.This setting returns the raw ID token returned by the authorization server after a call to get_authorization. This value may be used in subsequent requests as the value for the IDTokenHint setting. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
IDTokenHint:
An ID token value to be used as a hint about the user's session.This setting may be specified before calling get_authorization to pass an ID token as a hint about the user's current or past authenticated session. If the user identified by the ID token present here is logged in, then the authorization server should return a positive response. If Prompt is set to none this value should be set.
The value for this setting is the raw IDToken received from a previous authorization. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
LoginHint:
The login hint sent to the authorization server.This setting optionally specifies an identifier of the end-user which may be used as a hint to the authorization server about the user's identity. For instance this may be the email address or phone number of a user. The authorization may or may not use the value provided.
This setting corresponds to the login_hint request parameter. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
LogoutURL: The logout URL that is provided by the discovery document.This setting provides the logout URL that is parsed from the discovery document after get_discovery_doc is called. The logout URL is provided by the end_session_endpoint field in the discovery document. If the user is directed to the URL, they will be asked to log out of their account. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Prompt:
The requested conditions under which the authorization server prompts for login.This optional setting specifies the conditions under which the authorization server should prompt for login. The value specifies here is a space delimited, case sensitive list of one or more of the following values. For instance: login consent. Possible values are:
The prompt parameter can be used to make sure that the End-User is still present for the current session or to bring attention to the request. If this parameter contains none with any other value, an error is returned. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
RawJSON:
A JSON string holding the last response.This setting may be queried to retrieve the last response as a JSON string. The value returned by this setting depends on the most recently called method.
After get_discovery_doc is called this method returns the entire discovery document JSON. After get_authorization is called this method returns the ID token JSON. After get_user_info is called this method returns the response JSON. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ResponseType:
The value of the response_type request parameter.This setting optionally specifies the value of the response_type request parameter. When grant_type is set a value for the response_type is automatically chosen. If a different value is desired it may be specified here. The table below illustrates the default and possible values.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
XChildCount:
The number of child elements of the current element.The number of child attributes of the current element. The XChild configuration settings will be indexed from 0 to (XChildCount - 1).
The current element is specified via the XPath configuration setting. This configuration setting is read-only. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
XChildName[i]:
The name of the child element.Provides the name of the i'th child element of the current element.
The current element is specified via the XPath configuration setting. This configuration setting is read-only. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
XChildXText[i]:
The inner text of the child element.Provides the inner text of the i'th child element of the current element.
The current element is specified via the XPath configuration setting. This configuration setting is read-only. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
XElement:
The name of the current element.Provides the name of the current element.
The current element is specified via the XPath configuration setting. This configuration setting is read-only. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
XParent:
The parent of the current element.Provides the parent of the current element.
The current element is specified via the XPath configuration setting. This configuration setting is read-only. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
XPath:
Provides a way to point to a specific element in the returned XML or JSON response.The XPath setting allows you to point to specific elements in the XML or JSON response.
When XPath is set to a valid path, XElement points to the name of the element, with XText, XParent, XSubTree, XChildCount, XChildName[i], and XChildXText[i] providing other properties of the element.
XPath SyntaxXPath syntax is available for both XML and JSON documents. An XPath is a series of one or more element accessors separated by the / character, for example: /A/B/C/D. An XPath can be absolute (i.e., it starts with /), or it can be relative to the current xpath location. The following are possible values for an element accessor, which operates relative to the current location specified by the XPath accessors which proceed it in the overall XPath string:
XPath ExamplesAssuming the following XML response: <firstlevel> <one>value</one> <two> <item>first</item> <item>second</item> </two> <three>value three</three> </firstlevel> Or, alternatively, the following JSON response: { "firstlevel": { "one": "value", "two": ["first", "second"], "three": "value three" } } Here are some examples of valid XPaths:
This is not an exhaustive list by any means, but should provide a general idea of the possibilities. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
XSubTree:
A snapshot of the current element in the document.Provides the entirety of the current element (including its sub-elements).
The current element is specified via the XPath configuration setting. This configuration setting is read-only. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
XText:
The text of the current element.Provides the inner text of the current element.
The current element is specified in the XPath configuration setting. This configuration setting is read-only. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
OAuth Config Settings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
AuthorizationTokenType:
The type of access token returned.Applicable values for this configuration setting include the following:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
BrowserResponseTimeout: Specifies the amount of time to wait for a response from the browser.This configuration setting specifies the amount of time (in seconds) the component will wait for a response from the browser in the on_launch_browser event. The default value is 0, meaning that the component will wait indefinitely. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DeviceGrantType: The grant type to be used when the ClientProfile is set to ocpDevice.This configuration setting is used to specify a different grant type to use for device flow. By default this is set to "http://oauth.net/grant_type/device/1.0". Another commonly used grant type is "urn:ietf:params:oauth:grant-type:device_code". | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DeviceUserCode: The device's user code when the ClientProfile is set to ocpDevice.When client_profile is set to ocpDevice and get_authorization_url is called, the class will request a device user code from the server specified by server_auth_url. This configuration setting will be populated with the device user code returned by the server. Provide this value along with the URL returned by get_authorization_url to the user. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
FormVarCount:
Specifies the number of additional form variables to include in the request.This configuration setting may be used to specify additional form variables made in the request to exchange authorization_code
for an access token. This is useful in cases in which the OAuth server requires additional fields. This is used in
conjunction with FormVarName[i] and FormVarValue[i]. For instance:
component.Config("FormVarCount=2");
component.Config("FormVarName[0]=myvar");
component.Config("FormVarValue[0]=myvalue");
component.Config("FormVarName[1]=testname");
component.Config("FormVarValue[1]=testvalue");
The value will be URL encoded by the class
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
FormVarName[i]: Specifies the form variable name at the specified index.This configuration setting specifies the form variable name at the index specified. See FormVarCount for details. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
FormVarValue[i]: Specifies the form variable value at the specified index.This configuration setting specifies the form variable value at the index specified. See FormVarCount for details. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
IncludeEmptyRedirectURI:
Whether an empty redirect_uri parameter is included in requests.This configuration setting specifies whether redirect_uri is included in the request made by get_authorization if it is empty.
In most cases, redirect_uri will contain a value and will be sent; if, however, client_profile is set to Mobile or Device, this will be empty.
If set to True (default), the redirect_uri will be sent in all cases. If set to False, the redirect_uri will be sent only if it has a value. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
JWTAudience: The JWT audience when the ClientProfile is set to ocpJWT.This configuration setting specifies the audience that the JWT is intended for. This is required when client_profile is set to ocpJWT. When using Google service accounts, this value must be "https://www.googleapis.com/oauth2/v3/token". | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
JWTCertStore:
The name of the certificate store for the JWT signing certificate.The is the name of the certificate store for the JWT signing certificate.
The JWTCertStoreType field specifies the type of certificate store specified by JWTCertStore. If the store is password protected, specify the password in JWTCertStorePassword. JWTCertStore is used in conjunction with the JWTCertSubject field to specify the JWT signing certificate. Designations of certificate stores are platform-dependent. The following are designations of the most common User and Machine certificate stores in Windows:
When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store). Note: This is required when client_profile is set to ocpJWT. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
JWTCertStorePassword:
The JWT signing certificate password.If the certificate store is of a type that requires
a password, this property is used to specify that
password to open the certificate store.
Note: This is applicable only when client_profile is set to ocpJWT. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
JWTCertStoreType:
The type of certificate store.This configuration specifies the type of certificate store. Possible values are as follows:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
JWTCertSubject:
The JWT signing certificate subject.The is the subject of the JWT signing certificate.
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 displayed below.
If a field value contains a comma it must be quoted. Note: This is required when client_profile is set to ocpJWT. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
JWTIssuer: The JWT issuer when the ClientProfile is set to ocpJWT.This configuration setting specifies the issuer of the JWT (JSON Web Token). This is required when client_profile is set to ocpJWT. When using Google service accounts, this value is the email address of the service account. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
JWTJSONKey: The file path of the JWT JSON Key, or a string containing its content.This configuration setting specifies the file path of the JWT JSON Key, or a string containing its content, provided for the service account. If this setting is specified, the class will attempt to parse the values for JWTCertStore, JWTIssuer from the JSON file, as well as initializing the values for JWTCertStoreType, JWTCertStorePassword, and JWTCertSubject. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
JWTPayload:
The payload of the JWT access token if present.This configuration setting provides the payload section of a JWT access token if the access token is a JWT and the class is able to parse out the payload section.
This setting only applies to access tokens that are returned from a service provider after successfully authorizing and authenticating with the service.
This setting is not used when setting up the class for authentication when the client_profile is set to ocpJWT.
To parse the payload for specific claims, see JWTXPath. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
JWTServiceProvider:
The service provider to which authentication is being performed.This configuration setting specifies the service provider that is being authenticated to. Possible values are as follows:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
JWTSignatureAlgorithm:
The signature algorithm used to sign the JWT.This configuration setting specifies the signature algorithm used to sign the JWT. Possible values are as follows:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
JWTSubject: The subject field in the JWT.This configuration setting optionally specifies the subject field in the JWT. For Google service accounts, this is the email address of the user for which the application is requesting delegated access. The meaning of this value varies from service to service. Please consult the documentation for the service to which you are authenticating to determine if the "sub" field is applicable. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
JWTValidityTime:
The amount of time in seconds for which the assertion in the JWT is valid.The is the amount of time in seconds for which the assertion in the JWT is valid. The default value is 3600 (one hour).
Note: This is applicable only when client_profile is set to ocpJWT. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
JWTXChildCount:
The number of child elements of the current element.The number of child attributes of the current element. The XChild configuration settings will be indexed from 0 to (JWTXChildCount - 1).
The current element is specified in the JWTXPath configuration setting. This configuration setting is read-only. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
JWTXChildName[i]:
The name of the child element.Provides the name of the i'th child element of the current element.
The current element is specified in the JWTXPath configuration setting. This configuration setting is read-only. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
JWTXChildXText[i]:
The inner text of the child element.Provides the inner text of the i'th child element of the current element.
The current element is specified in the JWTXPath configuration setting. This configuration setting is read-only. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
JWTXElement:
The name of the current element.Provides the name of the current element.
The current element is specified in the JWTXPath configuration setting. This configuration setting is read-only. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
JWTXParent:
The parent of the current element.Provides the parent of the current element.
The current element is specified in the JWTXPath configuration setting. This configuration setting is read-only. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
JWTXPath:
Provides a way to point to a specific element in the returned payload of a JWT based access token.The JWTXPath setting allows you to point to specific claims within the payload of a JWT based access token.
XPath SyntaxXPath syntax is available for the payload of JWT based access tokens if available. An XPath is a series of one or more element accessors separated by the / character, for example: /A/B/C/D. The following are possible values for an element accessor, which operates relative to the current location specified by the XPath accessors which proceed it in the overall XPath string:
This is not an exhaustive list by any means, but should provide a general idea of the possibilities. To get the text of the specified element, see JWTXText. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
JWTXSubTree:
A snapshot of the current element in the document.Provides the entirety of the current element (including its sub-elements).
The current element is specified in the JWTXPath configuration setting. This configuration setting is read-only. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
JWTXText:
The text of the current element.Provides the inner text of the current element.
The current element is specified in the JWTXPath configuration setting. This configuration setting is read-only. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Microsoft365AdminConsentError: The error message returned when the admin denies consent to the scopes.When using the Microsoft365AdminConsent profile, this configuration setting will hold the error message in the event that the admin does not consent to the scope of the application. This configuration setting is read-only. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Microsoft365AdminConsentErrorDesc: The error description returned when the admin denies consent to the scopes.When using the Microsoft365AdminConsent profile, this configuration setting will hold the description of the error message in the event that the admin does not consent to the scope of the application. This configuration setting is read-only. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Microsoft365AdminConsentTenant: The tenant ID returned after the admin consents to the scopes.When using the Microsoft365AdminConsent profile, this configuration setting will hold the tenant Id that is returned after the admin consents to the scopes. This configuration setting is read-only. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Office365ServiceAPIVersion: The API version of the Office 365 service being discovered.This configuration setting specifies the API version of the Office 365 service for which a search is initiated. See Office365ServiceEndpoint for details. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Office365ServiceCapability: The API capability of the Office 365 service being discovered.This configuration setting specifies the capability of the Office 365 service for which a search is initiated. See Office365ServiceEndpoint for details. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Office365ServiceEndpoint:
The Office 365 endpoint for the service that matches the criteria specified.When obtaining authorization to access an Office 365 resource, it may be necessary to discover a list of
services that match a certain criteria and then select a specific resource from that list. For instance,
OneDrive for Business requires discovery of the Office 365 service that can be used with the OneDrive API.
When get_authorization is called, if Office365ServiceAPIVersion and Office365ServiceCapability are specified, the class will attempt to discover the Office 365 services for which the user has access and find a service that matches the requirements specified in Office365ServiceAPIVersion and Office365ServiceCapability. If a service is found, the class will then obtain authorization to access that service. If authorization is successful, Office365ServiceEndpoint will hold the service endpoint URL to which requests should be made. Example. OneDrive for Business:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PasswordGrantUsername: The Username field when using the password grant type.This configuration setting is used to set the username field when the grant_type is set to the password grant type and get_authorization is called. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PKCEChallengeEncoding:
The PKCE code challenge method to use.This configuration setting controls the PKCE code challenge method used when use_pkce is set to True. This value controls the PKCE code challenge method. Possible values are as follows:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PollingInterval: The interval in seconds between polling requests when the device client profile is used.When client_profile is set to ocpDevice, this configuration setting determines the interval (in seconds) between polling requests made to server_token_url. The default value is 5. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ResponseCompanyImage: A URL or full path to a company logo.This configuration setting specifies a URL or full path to a company logo. If set, the image will be displayed and will be a hyperlink to ResponseCompanyURL. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ResponseCompanyURL: A URL to the company website or similar resource.This configuration setting specifies a URL to the company website or similar resource. This is used in conjunction with ResponseCompanyImage. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ResponseFailureHeading: Short header text indicating failure.This configuration setting specifies short header text indicating failure. The default value is Authorization Failed. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ResponseFailureMessage: A description for a failed authorization.This configuration setting specifies a description for a failed authorization. The default value is Access to your account could not be authorized. Please check your user and connection details and try again. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ResponseHelpURL: A URL to a help page or other resource.This configuration setting specifies a URL to a help page or other resource. If set, a Help link will be displayed and point to this URL. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ResponseLicenseURL: A URL to licensing terms.This configuration setting specifies a URL to licensing terms. If set, a License link will be displayed and point to this URL. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ResponseProductImage: A URL or full path to a product image.This configuration setting specifies a URL or full path to a product image. If set, the image will be displayed and will be a hyperlink to ResponseProductURL. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ResponseProductURL: A URL to a product page or similar resource.This configuration setting specifies a URL to a product page or similar resource. This is used in conjunction with ResponseProductImage. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ResponseSuccessHeading: Short header text indicating success.This configuration setting specifies a short header text indicating success. The default value is Authorization Successful. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ResponseSuccessMessage: A description for a successful authorization.This configuration setting specifies a description for a successful authorization. The default value is Access to your account was successfully authorized. You may now close this window. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ReUseWebServer: Determines if the same server instance is used between requests.If this is set to True (default), the same embedded web server instance will be used for multiple requests. If set to False, the embedded web server will be created and destroyed on each call to get_authorization. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TokenInfoFieldCount: The number of fields in the tokeninfo service response.This configuration setting returns the number of fields present in the tokeninfo service response. This is populated after calling ValidateToken. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TokenInfoFieldName[i]: The name of the tokeninfo service response field.This configuration setting returns the name of the tokeninfo service response field specified by index i. Valid values are from 0 to TokenInfoFieldCount -1. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TokenInfoFieldValue[i]: The value of the tokeninfo service response field.This configuration setting returns the value of the tokeninfo service response field specified by index i. Valid values are from 0 to TokenInfoFieldCount -1. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TokenInfoURL: The URL of the tokeninfo service.This configuration setting specifies the URL of the tokeninfo service to which a request is made when ValidateToken is called. The default value is "https://www.googleapis.com/oauth2/v1/tokeninfo". | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ValidateToken: Validates the specified access token with a tokeninfo service.This configuration setting will post the access_token to the tokeninfo service specified by TokenInfoURL. This allows a token to be queried for validity and other information before use. When this configuration setting is queried, the class will immediately make a request to the server. TokenInfoFieldCount, TokenInfoFieldName[i], and TokenInfoFieldValue[i]] may be used to iterate over the fields in the response. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
WebServerFailedResponse: The custom response that will be displayed to the user if authentication failed.When get_authorization is called, the user will be redirected to the embedded web server upon completing authentication with the authorization server. If authentication fails, the HTML specified here will be sent to the user's browser. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
WebServerHost:
The hostname used by the embedded web server displayed in the ReturnURL.This configuration setting specifies the hostname used by the embedded web server when client_profile is set to ocpApplication.
This specifies the interface on which the embedded web server listens and also the value displayed in the return_url.
This should be set to the hostname only, and not to the full URL.
The default value is "localhost". |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
WebServerResponse: The custom response that will be displayed to the user.When get_authorization is called, the user will be redirected to the embedded web server upon completing authentication with the authorization server. This setting allows you to specify the HTML that will be sent to the user's browser. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
HTTP Config Settings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
AcceptEncoding: Used to tell the server which types of content encodings the client supports.When AllowHTTPCompression is True, the class adds an Accept-Encoding header to the request being sent to the server. By default, this header's value is "gzip, deflate". This configuration setting allows you to change the value of the Accept-Encoding header. Note: The class only supports gzip and deflate decompression algorithms. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
AllowHTTPCompression:
This property enables HTTP compression for receiving data.This configuration setting enables HTTP compression for receiving data.
When set to True (default), the class will accept compressed data. It then will uncompress the data it has received. The class will handle data compressed by both gzip and deflate compression algorithms.
When True, the class adds an Accept-Encoding header to the outgoing request. The value for this header can be controlled by the AcceptEncoding configuration setting. The default value for this header is "gzip, deflate". The default value is True. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
AllowHTTPFallback:
Whether HTTP/2 connections are permitted to fallback to HTTP/1.1.This configuration setting controls whether HTTP/2 connections are permitted to fall back to HTTP/1.1 when the server
does not support HTTP/2. This setting is applicable only when http_version is set to "2.0".
If set to True (default), the class will automatically use HTTP/1.1 if the server does not support HTTP/2. If set to False, the class fails with an error if the server does not support HTTP/2. The default value is True. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Append: Whether to append data to LocalFile.This configuration setting determines whether data will be appended when writing to local_file. When set to True, downloaded data will be appended to local_file. This may be used in conjunction with range to resume a failed download. This is applicable only when local_file is set. The default value is False. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Authorization:
The Authorization string to be sent to the server.If the Authorization property contains a nonempty string,
an Authorization HTTP request header is added to the
request. This header conveys Authorization information to the
server.
This property is provided so that the HTTP class can be extended with other security schemes in addition to the authorization schemes already implemented by the class. The auth_scheme property defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time user and password are set, they are Base64 encoded, and the result is put in the authorization property in the form "Basic [encoded-user-password]". |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
BytesTransferred: Contains the number of bytes transferred in the response data.This configuration setting returns the raw number of bytes from the HTTP response data, before the component processes the data, whether it is chunked or compressed. This returns the same value as the on_transfer event, by BytesTransferred. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ChunkSize: Specifies the chunk size in bytes when using chunked encoding.This is applicable only when UseChunkedEncoding is True. This setting specifies the chunk size in bytes to be used when posting data. The default value is 16384. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CompressHTTPRequest:
Set to true to compress the body of a PUT or POST request.If set to True, the body of a PUT or POST request will be compressed into gzip format before sending the request. The "Content-Encoding" header is also added to the outgoing request.
The default value is False. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
EncodeURL: If set to True the URL will be encoded by the class.If set to True, the URL passed to the class will be URL encoded. The default value is False. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
FollowRedirects:
Determines what happens when the server issues a redirect.This option 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 1 (always), the new url for the object is retrieved automatically every time.
If this property is set to 2 (Same Scheme), the new url is retrieved automatically only if the URL Scheme is the same; otherwise, the class fails with an error. Note: Following the HTTP specification, unless this option is set to 1 (Always), 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, unless this property is set to 1 (Always), in which case the same credentials are used to connect to the new server. A on_redirect event is fired for every URL the product is redirected to. In the case of automatic redirections, the on_redirect event is a good place to set properties related to the new connection (e.g., new authentication parameters). The default value is 0 (Never). In this case, redirects are never followed, and the class fails with an error instead. Following are the valid options:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GetOn302Redirect: If set to True the class will perform a GET on the new location.The default value is False. If set to True, the class will perform a GET on the new location. Otherwise, it will use the same HTTP method again. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
HTTP2HeadersWithoutIndexing: HTTP2 headers that should not update the dynamic header table with incremental indexing.HTTP/2 servers maintain a dynamic table of headers and values seen over the course of a connection. Typically, these headers are inserted into the table through incremental indexing (also known as HPACK, defined in RFC 7541). To tell the component not to use incremental indexing for certain headers, and thus not update the dynamic table, set this configuration option to a comma-delimited list of the header names. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
HTTPVersion:
The version of HTTP used by the class.This property specifies the HTTP version used by the class. Possible values are as follows:
When using HTTP/2 ("2.0"), additional restrictions apply. Please see the following notes for details.
HTTP/2 NotesWhen using HTTP/2, a secure Secure Sockets Layer/Transport Layer Security (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/2 will result in an error. If the server does not support HTTP/2, the class will automatically use HTTP/1.1 instead. This is done to provide compatibility without the need for any additional settings. To see which version was used, check NegotiatedHTTPVersion after calling a method. The AllowHTTPFallback setting controls whether this behavior is allowed (default) or disallowed.
HTTP/3 NotesHTTP/3 is supported only in .NET and Java. When using HTTP/3, a secure (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/3 will result in an error. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
IfModifiedSince:
A date determining the maximum age of the desired document.If this setting contains a nonempty string, an If-Modified-Since HTTP header is added to the request.
The value of this header is used to make the HTTP request conditional: if the requested documented has not
been modified since the time specified in the field, a copy of the document will not be returned from
the server; instead, a 304 (not modified) response will be returned by the server and the component throws an exception
The format of the date value for IfModifiedSince is detailed in the HTTP specs. For example:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
KeepAlive:
Determines whether the HTTP connection is closed after completion of the request.If True, the component will not send the Connection: Close header. The absence of the Connection header indicates to the server
that HTTP persistent connections should be used if supported.
Note: Not all servers support persistent connections. You also may explicitly add the Keep-Alive header to the request headers by setting other_headers to Connection: Keep-Alive.
If False, the connection will be closed immediately after the server response is received.
The default value for KeepAlive is False. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
KerberosSPN: The Service Principal Name for the Kerberos Domain Controller.If the Service Principal Name on the Kerberos Domain Controller is not the same as the URL that you are authenticating to, the Service Principal Name should be set here. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
LogLevel:
The level of detail that is logged.This configuration setting controls the level of detail that is logged through the on_log event. 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). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
MaxRedirectAttempts: Limits the number of redirects that are followed in a request.When follow_redirects is set to any value other than frNever, the class will follow redirects until this maximum number of redirect attempts are made. The default value is 20. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
NegotiatedHTTPVersion: The negotiated HTTP version.This configuration setting may be queried after the request is complete to indicate the HTTP version used. When http_version is set to "2.0" (if the server does not support "2.0"), then the class will fall back to using "1.1" automatically. This setting will indicate which version was used. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
OtherHeaders:
Other headers as determined by the user (optional).This configuration setting can be set to a string of headers to be appended to the HTTP request headers.
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 configuration setting with caution. If this configuration setting contains invalid headers, HTTP requests may fail. This configuration setting is useful for extending the functionality of the class beyond what is provided. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ProxyAuthorization: The authorization string to be sent to the proxy server.This is similar to the Authorization configuration setting, but is used for proxy authorization. If this configuration setting contains a nonempty string, a Proxy-Authorization HTTP request header is added to the request. This header conveys proxy Authorization information to the server. If proxy_user and proxy_password are specified, this value is calculated using the algorithm specified by proxy_auth_scheme. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ProxyAuthScheme: The authorization scheme to be used for the proxy.This configuration setting is provided for use by classs that do not directly expose Proxy properties. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ProxyPassword: A password if authentication is to be used for the proxy.This configuration setting is provided for use by classs that do not directly expose Proxy properties. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ProxyPort: Port for the proxy server (default 80).This configuration setting is provided for use by classs that do not directly expose Proxy properties. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ProxyServer: Name or IP address of a proxy server (optional).This configuration setting is provided for use by classs that do not directly expose Proxy properties. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ProxyUser: A user name if authentication is to be used for the proxy.This configuration setting is provided for use by classs that do not directly expose Proxy properties. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SentHeaders: The full set of headers as sent by the client.This configuration setting returns the complete set of raw headers as sent by the client. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
StatusLine: The first line of the last response from the server.This setting contains the first line of the last response from the server. The format of the line will be [HTTP version] [Result Code] [Description]. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TransferredData: The contents of the last response from the server.This configuration setting contains the contents of the last response from the server. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TransferredDataLimit: The maximum number of incoming bytes to be stored by the class.If TransferredDataLimit is set to 0 (default), no limits are imposed. Otherwise, this reflects the maximum number of incoming bytes that can be stored by the class. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TransferredHeaders: The full set of headers as received from the server.This configuration setting returns the complete set of raw headers as received from the server. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TransferredRequest:
The full request as sent by the client.This configuration setting returns the full request as sent by the client. For performance reasons, the request is not normally saved. Set this configuration setting to ON before making a request to enable it. Following are examples of this request:
.NET
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
UseChunkedEncoding:
Enables or Disables HTTP chunked encoding for transfers.If UseChunkedEncoding is set to True, the class will use HTTP-chunked encoding when posting, if possible.
HTTP-chunked encoding allows large files to be sent in chunks instead of all at once.
If set to False, the class will not use HTTP-chunked encoding. The default value is False.
Note: Some servers (such as the ASP.NET Development Server) may not support chunked encoding. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
UseIDNs:
Whether to encode hostnames to internationalized domain names.This configuration setting specifies whether hostnames containing non-ASCII characters are encoded to internationalized domain names. When set to True, if a hostname contains non-ASCII characters, it is encoded using Punycode to an IDN (internationalized domain name).
The default value is False and the hostname will always be used exactly as specified. Note: The CodePage setting must be set to a value capable of interpreting the specified host name. For instance, to specify UTF-8, set CodePage to 65001. In the C++ Edition for Windows, the *W version of the class must be used. For instance, DNSW or HTTPW. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
UsePlatformHTTPClient:
Whether or not to use the platform HTTP client.When using this configuration setting, if True, the component will use the default HTTP client for the platform (URLConnection in Java, WebRequest in .NET, or CFHTTPMessage in Mac/iOS) instead of the internal HTTP implementation. This is important for environments in which direct access to sockets is limited or not allowed (e.g., in the Google AppEngine).
Note: This setting is applicable only to Mac/iOS editions. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
UserAgent:
Information about the user agent (browser).This is the value supplied in the HTTP User-Agent header. The default
setting is "IPWorks HTTP Component - www.nsoftware.com".
Override the default with the name and version of your software. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TCPClient Config Settings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ConnectionTimeout: Sets a separate timeout value for establishing a connection.When set, this configuration setting allows you to specify a different timeout value for establishing a connection. Otherwise, the class will use timeout for establishing a connection and transmitting/receiving data. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
FirewallAutoDetect: Tells the class whether or not to automatically detect and use firewall system settings, if available.This configuration setting is provided for use by classs that do not directly expose Firewall properties. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
FirewallHost:
Name or IP address of firewall (optional).If a FirewallHost is given, requested connections will be authenticated through the specified firewall
when connecting.
If the FirewallHost setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the FirewallHost setting is set to the corresponding address. If the search is not successful, an error is returned. Note: This setting is provided for use by classs that do not directly expose Firewall properties. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
FirewallPassword:
Password to be used if authentication is to be used when connecting through the firewall.If FirewallHost is specified, the FirewallUser and FirewallPassword settings
are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.
Note: This setting is provided for use by classs that do not directly expose Firewall properties. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
FirewallPort:
The TCP port for the FirewallHost;.The FirewallPort is set automatically when FirewallType is set to a valid value.
Note: This configuration setting is provided for use by classs that do not directly expose Firewall properties. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
FirewallType:
Determines the type of firewall to connect through.The appropriate values are as follows:
Note: This setting is provided for use by classs that do not directly expose Firewall properties. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
FirewallUser:
A user name if authentication is to be used connecting through a firewall.If the FirewallHost is specified, the FirewallUser and FirewallPassword
settings are used to connect and authenticate to the Firewall. If the authentication fails, the class fails with an error.
Note: This setting is provided for use by classs that do not directly expose Firewall properties. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
KeepAliveInterval:
The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.When set, TCPKeepAlive will automatically be set to True.
A TCP keep-alive packet will be sent after a period of inactivity as
defined by KeepAliveTime. If no acknowledgment is received from the remote host, the keep-alive packet
will be sent again. This configuration setting specifies the interval at which the successive keep-alive packets are sent in milliseconds.
This system default if this value is not specified here is 1 second.
Note: This value is not applicable in macOS. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
KeepAliveTime: The inactivity time in milliseconds before a TCP keep-alive packet is sent.When set, TCPKeepAlive will automatically be set to True. By default, the operating system will determine the time a connection is idle before a Transmission Control Protocol (TCP) keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many cases, a shorter interval is more useful. Set this value to the desired interval in milliseconds. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Linger:
When set to True, connections are terminated gracefully.This property controls how a connection is closed. The default is True.
In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if LingerTime is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires. In the second scenario, if LingerTime is a positive value, the system will attempt to send pending data until the specified LingerTime is reached. If this attempt fails, then the system will reset the connection. The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the class returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes). Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
LingerTime: Time in seconds to have the connection linger. LingerTime is the time, in seconds, the socket connection will linger. This value is 0 by default, which means it will use the default IP timeout. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
LocalHost:
The name of the local host through which connections are initiated or accepted.
The local_host setting contains the name of the local host
as obtained by the gethostname() system call, or if the
user has assigned an IP address, the value of that address.
In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface. If the class is connected, the local_host setting shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
LocalPort:
The port in the local host where the class binds.
This must be set before a connection is
attempted. It instructs the class to bind to a specific
port (or communication endpoint) in the local machine.
Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by local_port after the connection is established. local_port cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error. This; setting is useful when trying to connect to services that require a trusted port in the client side. An example is the remote shell (rsh) service in UNIX systems. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
MaxLineLength:
The maximum amount of data to accumulate when no EOL is found.MaxLineLength is the size of an internal buffer, which holds received data while waiting for an eol
string.
If an eol string is found in the input stream before MaxLineLength bytes are received, the on_data_in event is fired with the EOL parameter set to True, and the buffer is reset. If no eol is found, and MaxLineLength bytes are accumulated in the buffer, the on_data_in event is fired with the EOL parameter set to False, and the buffer is reset. The minimum value for MaxLineLength is 256 bytes. The default value is 2048 bytes. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
MaxTransferRate: The transfer rate limit in bytes per second.This configuration setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default, this is not set and there is no limit. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ProxyExceptionsList:
A semicolon separated list of hosts and IPs to bypass when using a proxy.This configuration setting optionally specifies a semicolon-separated list of hostnames or IP addresses to bypass when a proxy is in use.
When requests are made to hosts specified in this property, the proxy will not be used. For instance:
www.google.com;www.nsoftware.com |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TCPKeepAlive:
Determines whether or not the keep alive socket option is enabled.If set to True, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically
to maintain the connection. Set KeepAliveTime and KeepAliveInterval to
configure the timing of the keep-alive packets.
Note: This value is not applicable in Java. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TcpNoDelay:
Whether or not to delay when sending packets.
When true, the socket will send all data that is ready to send at once. When
false, the socket will send smaller buffered packets of data at small intervals.
This is known as the Nagle algorithm.
By default, this config is set to false. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
UseIPv6:
Whether to use IPv6.When set to 0 (default), the class will use IPv4 exclusively.
When set to 1, the class will use IPv6 exclusively. To instruct the class to prefer IPv6 addresses, but use IPv4 if IPv6 is not supported on the system, this setting should be set to 2. The default value is 0.
Possible values are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Socket Config Settings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
AbsoluteTimeout:
Determines whether timeouts are inactivity timeouts or absolute timeouts.If AbsoluteTimeout is set to True, any method which does not complete within Timeout seconds
will be aborted. By default, AbsoluteTimeout is False, and the timeout is an inactivity timeout.
Note: This option is not valid for UDP ports. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
FirewallData: Used to send extra data to the firewall.When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g. headers for custom authentication schemes). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
InBufferSize:
The size in bytes of the incoming queue of the socket.
This is the size of an internal queue in the TCP/IP stack.
You can increase or decrease its size depending on the amount
of data that you will be receiving. Increasing the value of the
InBufferSize setting can provide significant improvements in
performance in some cases.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
OutBufferSize:
The size in bytes of the outgoing queue of the socket.This is the size of an internal queue in the TCP/IP stack.
You can increase or decrease its size depending on the amount
of data that you will be sending. Increasing the value of the
OutBufferSize setting can provide significant improvements in
performance in some cases.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Base Config Settings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
BuildInfo: Information about the product's build.When queried, this setting will return a string containing information about the product's build. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CodePage:
The system code page used for Unicode to Multibyte translations.The default code page is Unicode UTF-8 (65001).
The following is a list of valid code page identifiers:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
LicenseInfo:
Information about the current license.When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
MaskSensitive:
Whether sensitive data is masked in log messages.In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to True to mask sensitive data. The default is False.
This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ProcessIdleEvents: Whether the class uses its internal event loop to process events when the main thread is idle.If set to False, the class will not fire internal idle events. Set this to False to use the class in a background thread on Mac OS. By default, this setting is True. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SelectWaitMillis: The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.If there are no events to process when do_events is called, the class will wait for the amount of time specified here before returning. The default value is 20. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
UseFIPSCompliantAPI:
Tells the class whether or not to use FIPS certified APIs.When set to True, the class will utilize the underlying operating system's certified APIs. Java editions, regardless of OS, utilize Bouncy Castle FIPS, while all the other Windows editions make use of Microsoft security libraries.
FIPS mode can be enabled by setting the UseFIPSCompliantAPI configuration setting to True. This is a static setting which applies to all instances of all classes of the toolkit within the process. It is recommended to enable or disable this setting once before the component has been used to establish a connection. Enabling FIPS while an instance of the component is active and connected may result in unexpected behavior. For more details please see the FIPS 140-2 Compliance article. Note: This setting is only applicable on Windows. Note: Enabling FIPS-compliance requires a special license; please contact sales@nsoftware.com for details. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
UseInternalSecurityAPI:
Tells the class whether or not to use the system security libraries or an internal implementation.
When set to False, the class will use the system security libraries by default to perform cryptographic functions where applicable.
Setting this setting to True tells the class to use the internal implementation instead of using the system security libraries. On Windows, this setting is set to False by default. On Linux/macOS, this setting is set to True by default. To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the OpenSSL Notes section. |
OpenID Errors
OpenID Errors
900 Invalid discovery document. The data is not a properly formatted discovery document. | |
901 Invalid ID token. The ID token could not be parsed. | |
902 Invalid ResponseType specified. The supplied ResponseType was unrecognized. | |
903 ID Token verification failed. |
The class may also return one of the following error codes, which are inherited from other classes.
HTTP Errors
118 Firewall Error. Error description contains detailed message. | |
143 Busy executing current method. | |
151 HTTP protocol error. The error message has the server response. | |
152 No server specified in url | |
153 Specified url_scheme is invalid. | |
155 Range operation is not supported by server. | |
156 Invalid cookie index (out of range). | |
301 Interrupted. | |
302 Can't open attached_file. |
The class may also return one of the following error codes, which are inherited from other classes.
TCPClient Errors
100 You cannot change the remote_port at this time. A connection is in progress. | |
101 You cannot change the remote_host (Server) at this time. A connection is in progress. | |
102 The remote_host address is invalid (0.0.0.0). | |
104 Already connected. If you want to reconnect, close the current connection first. | |
106 You cannot change the local_port at this time. A connection is in progress. | |
107 You cannot change the local_host at this time. A connection is in progress. | |
112 You cannot change MaxLineLength at this time. A connection is in progress. | |
116 remote_port cannot be zero. Please specify a valid service port number. | |
117 You cannot change the UseConnection option while the class is active. | |
135 Operation would block. | |
201 Timeout. | |
211 Action impossible in control's present state. | |
212 Action impossible while not connected. | |
213 Action impossible while listening. | |
301 Timeout. | |
302 Could not open file. | |
434 Unable to convert string to selected CodePage. | |
1105 Already connecting. If you want to reconnect, close the current connection first. | |
1117 You need to connect first. | |
1119 You cannot change the LocalHost at this time. A connection is in progress. | |
1120 Connection dropped by remote host. |
TCP/IP Errors
10004 [10004] Interrupted system call. | |
10009 [10009] Bad file number. | |
10013 [10013] Access denied. | |
10014 [10014] Bad address. | |
10022 [10022] Invalid argument. | |
10024 [10024] Too many open files. | |
10035 [10035] Operation would block. | |
10036 [10036] Operation now in progress. | |
10037 [10037] Operation already in progress. | |
10038 [10038] Socket operation on non-socket. | |
10039 [10039] Destination address required. | |
10040 [10040] Message too long. | |
10041 [10041] Protocol wrong type for socket. | |
10042 [10042] Bad protocol option. | |
10043 [10043] Protocol not supported. | |
10044 [10044] Socket type not supported. | |
10045 [10045] Operation not supported on socket. | |
10046 [10046] Protocol family not supported. | |
10047 [10047] Address family not supported by protocol family. | |
10048 [10048] Address already in use. | |
10049 [10049] Can't assign requested address. | |
10050 [10050] Network is down. | |
10051 [10051] Network is unreachable. | |
10052 [10052] Net dropped connection or reset. | |
10053 [10053] Software caused connection abort. | |
10054 [10054] Connection reset by peer. | |
10055 [10055] No buffer space available. | |
10056 [10056] Socket is already connected. | |
10057 [10057] Socket is not connected. | |
10058 [10058] Can't send after socket shutdown. | |
10059 [10059] Too many references, can't splice. | |
10060 [10060] Connection timed out. | |
10061 [10061] Connection refused. | |
10062 [10062] Too many levels of symbolic links. | |
10063 [10063] File name too long. | |
10064 [10064] Host is down. | |
10065 [10065] No route to host. | |
10066 [10066] Directory not empty | |
10067 [10067] Too many processes. | |
10068 [10068] Too many users. | |
10069 [10069] Disc Quota Exceeded. | |
10070 [10070] Stale NFS file handle. | |
10071 [10071] Too many levels of remote in path. | |
10091 [10091] Network subsystem is unavailable. | |
10092 [10092] WINSOCK DLL Version out of range. | |
10093 [10093] Winsock not loaded yet. | |
11001 [11001] Host not found. | |
11002 [11002] Non-authoritative 'Host not found' (try again or check DNS setup). | |
11003 [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP. | |
11004 [11004] Valid name, no data record (check DNS setup). |