Data
- Default Namespace
- XML Schema File: ns0.xsd
The data in this namespace is divided into elements and types. Types define the structure of the data. Elements define specific instances of the types, and are therefore more relevant to REST endpoints, which generally consume and/or produce elements.
The following elements are members of this namespace:
The following types are members of this namespace:
Element crowdConfigurationWrapper
A rest request/response resource wrapper, that contains a data parameter, which is the crowd configuration.
Example XML
<?xml version="1.0" encoding="UTF-8"?>
<crowdConfigurationWrapper>
<data>
<!--content of type 'crowdConfiguration'-->
<applicationName>
<!--content of type 'string'-->
...
</applicationName>
<applicationPassword>
<!--content of type 'string'-->
...
</applicationPassword>
<crowdServerUrl>
<!--content of type 'string'-->
...
</crowdServerUrl>
<sessionKeyIsAuthenticated>
<!--content of type 'string'-->
...
</sessionKeyIsAuthenticated>
<sessionKeyTokenKey>
<!--content of type 'string'-->
...
</sessionKeyTokenKey>
<sessionValidationInterval>
<!--content of type 'int'-->
...
</sessionValidationInterval>
<sessionKeyLastValidation>
<!--content of type 'string'-->
...
</sessionKeyLastValidation>
<useGroups>
<!--content of type 'boolean'-->
...
</useGroups>
<httpProxyHost>
<!--content of type 'string'-->
...
</httpProxyHost>
<httpProxyPort>
<!--content of type 'int'-->
...
</httpProxyPort>
<httpProxyUsername>
<!--content of type 'string'-->
...
</httpProxyUsername>
<httpProxyPassword>
<!--content of type 'string'-->
...
</httpProxyPassword>
<httpMaxConnections>
<!--content of type 'int'-->
...
</httpMaxConnections>
<httpTimeout>
<!--content of type 'int'-->
...
</httpTimeout>
<cookieTokenKey>
<!--content of type 'string'-->
...
</cookieTokenKey>
</data>
</crowdConfigurationWrapper>
Example JSON
{
"data" : {
"applicationName" : "...",
"applicationPassword" : "...",
"crowdServerUrl" : "...",
"sessionKeyIsAuthenticated" : "...",
"sessionKeyTokenKey" : "...",
"sessionValidationInterval" : ...,
"sessionKeyLastValidation" : "...",
"useGroups" : false,
"httpProxyHost" : "...",
"httpProxyPort" : ...,
"httpProxyUsername" : "...",
"httpProxyPassword" : "...",
"httpMaxConnections" : ...,
"httpTimeout" : ...,
"cookieTokenKey" : "..."
}
}
Type crowdConfiguration
Crowd configuration parameters.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
applicationName (string) | 0/1 | Get the application name registered with Crowd. |
applicationPassword (string) | 0/1 | Get the application password registered with Crowd. |
crowdServerUrl (string) | 0/1 | Get the Crowd Server URL. |
sessionKeyIsAuthenticated (string) | 0/1 | Get the session key to use when storing a Boolean value indicating whether the user is authenticated or not. |
sessionKeyTokenKey (string) | 0/1 | Get the session key to use when storing a Boolean value indicating whether the user is authenticated or not. |
sessionValidationInterval (int) | 0/1 | Get the session key to use when storing an Integer value of the number of minutes between authentication validation. If this value is set to 0, each HTTP request will be authenticated. |
sessionKeyLastValidation (string) | 0/1 | Get the session key to use when storing a Date value of the user's last authentication. |
useGroups (boolean) | 1/1 | Get flag that if true, Crowd groups will be used as the source of role names. |
httpProxyHost (string) | 0/1 | Get the name of the proxy server used to transport SOAP traffic to the Crowd server. |
httpProxyPort (int) | 0/1 | Get the connection port of the proxy server (must be specified if a proxy host is specified). |
httpProxyUsername (string) | 0/1 | Get the username used to authenticate with the proxy server (if the proxy server requires authentication). |
httpProxyPassword (string) | 0/1 | Get the password used to authenticate with the proxy server (if the proxy server requires authentication). |
httpMaxConnections (int) | 0/1 | Get the maximum number of HTTP connections in the connection pool for communication with the Crowd server. |
httpTimeout (int) | 0/1 | Get the HTTP connection timeout (milliseconds) used for communication with the Crowd server. A value of zero indicates that there is no connection timeout. |
cookieTokenKey (string) | 0/1 | When using Crowd for single sign-on (SSO), you can specify the SSO cookie name for each application. Under the standard configuration, Crowd will use a single, default cookie name for all Crowd-connected applications. You can override the default with your own cookie name. As well as allowing you to define the SSO cookie name, this feature also allows you to divide your applications into different SSO groups. For example, you might use one SSO token for your public websites and another for your internal websites. |
Type crowdConfigurationResource
A rest request/response resource wrapper, that contains a data parameter, which is the crowd configuration.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
data (crowdConfiguration) | 0/1 | Get The crowd configuration object. |