OpenId Authentication (openId)
OpenId authentication.
Name | Type | Default | Description |
---|---|---|---|
authFilterRef | A reference to top level authFilter element (string). | Specifies the authentication filter reference. | |
authenticationMode |
| checkid_setup | Specifies the OpenID provider authentication mode either checkid_immediate or checkid_setup. checkid_setup is the default authentication mode. |
hashAlgorithm |
| SHA256 | Specifies the hash algorithm that is used to sign and encrypt the OpenID provider response parameters. |
hostNameVerificationEnabled | boolean | true | Specifies whether enable host name verification or not. |
httpsRequired | boolean | true | Require SSL communication between the OpenID relying party and provider service. |
mapIdentityToRegistryUser | boolean | false | Specifies whether to map identity to registry user. The user registry is not used to create the user subject. |
providerIdentifier | string | Specifies a default OpenID provider URL where users get the Open IDs. | |
realmIdentifier | string | Specifies the attribute for the OpenID provider name. | |
sslRef | A reference to top level ssl element (string). | Specifies an ID of the SSL configuration is used to connect to the OpenID provider. | |
useClientIdentity | boolean | false | Specifies whether to use the client OpenID identity to create a user subject. If set to true, only the OpenID client identity is used. If set to false and the first element of userInfoRef is found, we use it to create a user subject. Otherwise, we use the OpenID identity to create a user subject. |
userInfoRef | List of references to top level userInfo elements (comma-separated string). | Specifies a list of userInfo references separated by commas for the OpenID provider to include in the response. |
authFilter
Specifies the authentication filter reference.
authFilter > cookie
A unique configuration ID.
Name | Type | Default | Description |
---|---|---|---|
id | string | A unique configuration ID. | |
matchType |
| contains | Specifies the match type. |
name | string | Specifies the name. |
authFilter > host
A unique configuration ID.
Name | Type | Default | Description |
---|---|---|---|
id | string | A unique configuration ID. | |
matchType |
| contains | Specifies the match type. |
name | string | Specifies the name. |
authFilter > remoteAddress
A unique configuration ID.
Name | Type | Default | Description |
---|---|---|---|
id | string | A unique configuration ID. | |
ip | string | Specifies the remote host TCP/IP address. | |
matchType |
| contains | Specifies the match type. |
authFilter > requestHeader
A unique configuration ID.
Name | Type | Default | Description |
---|---|---|---|
id | string | A unique configuration ID. | |
matchType |
| contains | Specifies the match type. |
name | string | Specifies the name. | |
value | string | The value attribute specifies the value of the request header. If the value is not specified, then the name attribute is used for matching, for example, requestHeader id="sample" name="email" matchType="contains". |
authFilter > requestUrl
A unique configuration ID.
Name | Type | Default | Description |
---|---|---|---|
id | string | A unique configuration ID. | |
matchType |
| contains | Specifies the match type. |
urlPattern | string | Specifies the URL pattern. The * character is not supported to be used as a wildcard. |
authFilter > userAgent
A unique configuration ID.
Name | Type | Default | Description |
---|---|---|---|
agent | string | Specifies the browser's user agent to help identify which browser is being used. | |
id | string | A unique configuration ID. | |
matchType |
| contains | Specifies the match type. |
authFilter > webApp
A unique configuration ID.
Name | Type | Default | Description |
---|---|---|---|
id | string | A unique configuration ID. | |
matchType |
| contains | Specifies the match type. |
name | string | Specifies the name. |
userInfo
Specifies a list of userInfo references separated by commas for the OpenID provider to include in the response.
Name | Type | Default | Description |
---|---|---|---|
alias | string | Specifies an alias name. | |
count | int | 1 | Specifies how much userInfo is included in the response of the openID provider. |
id | string | A unique configuration ID. | |
required | boolean | true | Specifies whether user information is required or not. |
uriType | string | http://axschema.org/contact/email | Specifies a URI type. |