Documentation > Access API > AuthController > accessapi/Auth/AuthenticateWithCache
accessapi/Auth/AuthenticateWithCache
Create a new user session on the specified server and instance. The response will contain contents that can be used for caching.
POST
https://cms.crownpeak.com/[Your Instance]/cpt_webservice/accessapi/Auth/AuthenticateWithCacheRequest Information
URI Parameters
None.
Body Parameters
The parameters sent as post data.
AuthAuthenticateWithCacheRequest
| Name | Description | Type |
|---|---|---|
| instance | System.String | |
| password | System.String | |
| remember_me | System.Boolean | |
| timeZoneOffsetMinutes | System.Int32 | |
| username | System.String |
Request Formats
application/json
Sample:
{
"instance": "AdventGeneral",
"username": "username",
"password": "password",
"remember_me": false,
"timeZoneOffsetMinutes": -480
}
Response Information
Resource Description
AuthAuthenticateWithCacheResponse
| Name | Description | Type |
|---|---|---|
| actions | Dictionary<System.Int32, CrownPeakApp.Model.ActionData> | |
| daysToExpire | System.Int32 | |
| idleTimeoutMinutes | System.Int32 | |
| instanceWysiwygEditor | CrownPeakApp.Model.WysiwygEditorType | |
| needsExpirationWarning | System.Boolean | |
| ResultCode | eResultCodes | |
| statusData | Dictionary<System.Int32, CrownPeakApp.Model.StatusData> | |
| systemModelsPathId | System.Int32 | |
| systemTemplatesPathId | System.Int32 | |
| taskBaseModelId | System.Int32 | |
| taskCount | System.Int32 | |
| tasksFolderId | System.Int32 | |
| uiConfiguration | List<CrownPeakApp.Model.cpKeyValuePair> | |
| user | CrownPeakApp.Model.UserData | |
| wcoBeaconSites | List<CrownPeakApp.Model.WCOBeaconSiteData> | |
| workflowData | Dictionary<System.Int32, CrownPeakApp.Model.WorkflowData> | |
| workflowTaskCount | System.Int32 | |
| actions | Dictionary<Int32,ActionData> | |
| ActivityUsers | List<ActivityUserData> | |
| ConnectorUpdateData | List<ConnectorAsset> | |
| daysToExpire | System.Int32 | |
| DeviceLayouts | CrownPeakApp.Model.UIModel.DeviceLayoutData[] | |
| ErrorMessage | System.String | |
| FolderOptionData | CrownPeakApp.Model.FolderOptionData[] | |
| GroupPermissionList | System.String | |
| idleTimeoutMinutes | System.Int32 | |
| instanceWysiwygEditor | CrownPeakApp.Model.WysiwygEditorType | |
| InternalCode | System.Int32 | |
| IsConnectorDataChanged | System.Boolean | |
| IsMaintenanceMessageChanged | System.Boolean | |
| IsStatusDataChanged | System.Boolean | |
| IsSuccessful | System.Boolean | |
| IsWorkflowDataChanged | System.Boolean | |
| Layouts | CrownPeakApp.Model.LayoutData[] | |
| MachineNumber | System.String | |
| MaintenanceMessage | System.String | |
| needsExpirationWarning | System.Boolean | |
| PreferenceData | CrownPeakApp.Model.PreferenceData | |
| PublishingServers | List<PublishingServer> | |
| statusData | Dictionary<Int32,StatusData> | |
| systemModelsPathId | System.Int32 | |
| systemTemplatesPathId | System.Int32 | |
| taskBaseModelId | System.Int32 | |
| taskCount | System.Int32 | |
| tasksFolderId | System.Int32 | |
| uiConfiguration | List<cpKeyValuePair> | |
| user | CrownPeakApp.Model.UserData | |
| wcoBeaconSites | List<WCOBeaconSiteData> | |
| workflowData | Dictionary<Int32,WorkflowData> | |
| workflowTaskCount | System.Int32 |
Response Formats
application/json
Sample:
{
"user": {
"expires": null,
"id": 11,
"enabled": true,
"lastLoginDate": "2014-10-29T10:02:22.413",
"lastLoginAddr": "192.168.100.94/192.168.100.94",
"avatar": "you.png",
...
"preferences": {
"startupFileOrFolderId": 5646,
"startupFileOrFolderPath": "/AdventGeneral/Assets/XMLTest.xml",
...
},
"idpName": "Standard"
},
"systemTemplatesPathId": 756,
"systemModelsPathId": 22,
"actions": {
"4": {
"action": "Made Hidden",
"description": "Made this document hidden"
},
...
},
"instanceWysiwygEditor": "Ephox",
"uiConfiguration": [
{
"key": "custom_help_asset",
"value": "-1"
},
{
"key": "enableInlineMode",
"value": "0"
},
...
],
"workflowData": {
"0": {
"id": 0,
"name": "default",
"description": "",
"stepCommands": {},
"modifiedBy": null,
"modifiedDate": "0001-01-01T00:00:00",
"usage": 1050
},
...
"statusData": {
"780": {
"id": 780,
"name": "Draft",
"color": "8DBEDA"
},
...
},
"wcoBeaconSites": [],
"preferenceData": {
"startupFileOrFolderId": 5646,
"startupFileOrFolderPath": "/AdventGeneral/Assets/XMLTest.xml",
...
},
"publishingServers": [
{
"id": 11,
"repository_id": null,
"name": "Dev",
"soap_id": null,
"odbc_id": null,
"smtp_id": null,
"http_id": null,
"enabled": false,
"configured_hostname": null,
"encodeUTF8": false,
"package_state": 0,
"configured_path": null,
"repositoryServer": null
},
...
],
"activityUsers": [
{
"id": 11,
"lname": "Admin",
"fname": "CrownPeak",
"fullName": "CrownPeak Admin",
"avatar": "/cpt_avatars/SL/you.png"
},
...
],
"layouts": [
{
"displayName": "Output",
"fileName": "output.aspx",
"icon": null
}
...
],
"resultCode": "conWS_Success",
"errorMessage": "",
"internalCode": 0
}