Parameters
| Name |
Description |
Token required |
Access Token. Development environment token is: )kkp!A_Qv_FW4r:sa{TCuZs/z.1v(BeC |
Page * optional |
int if not passed will always return first page. |
PageSize * optional |
int Number of records returned by query. Default value is: 25. |
Limit * optional |
int Limit of records returned by query. Default value defined in Admin > Properties > Search Results Limit. |
OrderBy * optional |
string Name of the column search results will be sorted by. Default value is: UserName. |
Filter * optional |
string Retrieves a record with the given Filter Example: UserId='0d098c63-1a84-4044-8c9e-b98fc6b3608d'. |
DisplayActiveUsers * optional |
bool Will only display users who have access to the Website and/or console by appending IsDeleted = 0 AND IsLockedOut = 0 to the filter. Default value is: true. |
ReturnProperties * optional |
bool Will return user Properties. Default value is: false. |
ReturnConfiguration * optional |
bool Will return user Configuration. Default value is: false. |
ReturnPersonalization * optional |
bool Will return user Personalization. Default value is: false. |
ReturnAudiences * optional |
bool Will return user Audience ID's. Default value is: false. |
ReturnRoles * optional |
bool Will return user Role ID's. Default value is: false. |
ReturnAudiencesIntegrationIds * optional |
bool Will return user Audience Integration ID's. Default value is: false. |
ReturnRolesIntegrationIds * optional |
bool Will return user Role Integration ID's. Default value is: false. |
|
|
Example:
{
"Token": ")kkp!A_Qv_FW4r:sa{TCuZs/z.1v(BeC"
}
Response (user object will not be displayed in this example but explained below)
{
"Success": true,
"Result": {
"ReturnedRecords": 25,
"TotalRecords": 94,
"NumberOfPages": 4,
"Users": [.....
]
}
}
Response Properties
| Name |
Description |
Success |
bool If response is successful. |
Result |
Contains a object of the response. |
Result Properties |
ReturnedRecords |
int Number of records returned by query. |
TotalRecords |
int Total number of records based on query. |
NumberOfPages |
int Total number of pages based on query. |
Users
UserId |
Guid. |
ParentUserId |
Guid. |
UserName |
String. |
Email |
String. |
IsLockedOut |
Boolean. |
LastLoginDate |
DateTime. |
LastPasswordChangedDate |
DateTime. |
FailedPasswordAttemptCount |
Int32. |
Personalization
String To return set: ReturnPersonalization to true.
CpGridRowSelectorPopulatesSearchWithDataKeyInsidersModeVersionCompareEditorComparisonAlgorithmAttributeNameFontWeightSiteTitleVersionCompareOpenAllAttibutesEditorModeControlWidthDisplayVersionTimeZoneIdDisplayTimerCultureNameDefaultSortVersionCompareShowOnlyChangedAttibutesCpEditorHighlightCpScriptingDisplayPageScrollerPageSizeVersionCompareShowHiddenAttibutesDisplaySystemNamesDisplaySavePlusNewButtonAudiencesPostingModeHealthMonitorDefaultReportsTypeSourceEncodingCodePageCheckBoxLocation
|
Configuration
String To return set: ReturnConfiguration to true.
AuthenticationSourcesOAuthRefreshTokenShowHistoryAccountVerificationKeyOwaUsernameAuthenticationSourcesSamlAttributesAuthenticationSourcesOAuthAccessTokenUtcExpireDateOwaPasswordAccountVerifiedAuthenticationSourcesOAuthSalesforceUserInfoUrlImportedPasswordSiteMapItemsOwaServerSelectSiteMapItemsAuthenticationSourcesOAuthAccessTokenPasswordChangeVerificationKeyViewCommentsAuthenticationSourcesOAuthSourcePasswordChangeRequiredShowNotesBetweenEditorsAuthenticationSourcesOAuthTwitterTokenSecretLoginRedirectUrl
|
Properties
String To return set: ReturnProperties to true.
ContactProvince ContactCellPhone ContactPhoto TenantsA ContactPostalCode ContactHomePhone ContactOfficePhone ContactCompanyPosition ContactSuffix ContactMiddleName ContactFirstName ContactCity ContactCellPhoneProvider Alltel,AT&T,Boost Mobile,Cricket Wireless,Sprint,T-Mobile,Verizon, Virgin Mobile USAContactTitle Dr, Miss, Mr, MsSubscribedDataBroadcasts ContactAddress ContactCompany GeoCode ContactState 2 upper case letter abbreviations. Example: AL, AK, AZMfaTotpSecretKey ContactCountry AutoUpdateGeoCode ContactFax MfaType ContactLastName
|
IntegrationId |
String. |
IsDeleted |
Boolean. |
IsSystem |
Boolean. |
CreateDate |
DateTime. |
ModifyDate |
DateTime. |
IsLocal |
Boolean. |
AuthenticationSourcesDataId |
Guid. |
DisplayName |
String. |
StartDate |
DateTime. |
EndDate |
DateTime. |
AuthenticationSourcesCredentials |
String. |
DynamicRoles |
Boolean. |
GeoCode |
String. |
Latitude |
Double. |
Longitude |
Double. |
GroupId |
String. |
RoleIds |
Array Guid's. |
RoleIntegrationIds |
Array Strings. |
AudienceIds |
Array Guid's. |
AudienceIntegrationIds |
Array Strings. |
|
Array Array of user properties based on query. |
|
* PasswordHash column was removed from response for security reasons.
|
Example (filtered results return all data):
{
"Token": ")kkp!A_Qv_FW4r:sa{TCuZs/z.1v(BeC",
"Page": 1,
"PageSize": 25,
"Limit": 1000,
"OrderBy": "UserName",
"DisplayActiveUsers": true,
"ReturnProperties": true,
"ReturnConfiguration": true,
"ReturnPersonalization": true,
"ReturnAudiences": true,
"ReturnRoles": true,
"ReturnAudiencesIntegrationIds": true,
"ReturnRolesIntegrationIds": true,
"Filter": "UserId='0d098c63-1a84-4044-8c9e-b98fc6b3608d' OR Email='admins@wellcare.com'"
}
Response
{
"Success": true,
"Result": {
"ReturnedRecords": 2,
"TotalRecords": 2,
"NumberOfPages": 1,
"Users": [
{
"UserId": "71bb4378-c8de-4ec2-acca-493b9346ba12",
"ParentUserId": null,
"UserName": "admins",
"Email": "admins@wellcare.com",
"IsLockedOut": false,
"LastLoginDate": "2019-02-21T20:29:32.43",
"LastPasswordChangedDate": "2019-02-15T19:08:57.673",
"FailedPasswordAttemptCount": 0,
"Personalization": {
"CpGridRowSelectorPopulatesSearchWithDataKey": "0",
"PageSize": "25",
"AttributeNameFontWeight": "Bold",
"SiteTitle": "",
"VersionCompareOpenAllAttibutes": "0",
"ControlWidth": "Dynamic",
"DisplayVersion": "0",
"TimeZoneId": "Eastern Standard Time",
"DisplayTimer": "0",
"CultureName": "en-US",
"DefaultSort": "{0}.Title",
"VersionCompareShowOnlyChangedAttibutes": "1",
"DisplayPageScroller": "0",
"VersionCompareEditorComparisonAlgorithm": "1",
"VersionCompareShowHiddenAttibutes": "0",
"CpEditorHighlightCpScripting": "0",
"DisplaySavePlusNewButton": "AddNewOnly",
"AudiencesPostingMode": "Combined",
"HealthMonitorDefaultReportsType": "0",
"SourceEncodingCodePage": "65001",
"DisplaySystemNames": "0",
"CheckBoxLocation": "Left"
},
"Configuration": {
"ShowHistory": "0",
"AccountVerificationKey": "",
"OwaUsername": "",
"AuthenticationSourcesOAuthAccessTokenUtcExpireDate": "",
"OwaPassword": "",
"AccountVerified": "0",
"AuthenticationSourcesOAuthSalesforceUserInfoUrl": "",
"ViewComments": "0",
"ImportedPassword": "",
"SiteMapItems": "095ab16a-cc7a-42c3-9f43-239f7241f614",
"AuthenticationSourcesOAuthTwitterTokenSecret": "",
"PasswordChangeRequired": "0",
"OwaServer": "",
"AuthenticationSourcesOAuthAccessToken": "",
"PasswordChangeVerificationKey": "",
"SelectSiteMapItems": "0",
"AuthenticationSourcesOAuthSource": "",
"AuthenticationSourcesOAuthRefreshToken": "",
"ShowNotesBetweenEditors": "0",
"AuthenticationSourcesSamlAttributes": "",
"LoginRedirectUrl": ""
},
"Properties": {
"ContactCellPhone": "",
"ContactPhoto": "",
"TenantsA": "",
"ContactPostalCode": "",
"ContactOfficePhone": "",
"MyLinks": "",
"ContactCountry": "",
"ContactSuffix": "",
"ContactMiddleName": "",
"ContactFirstName": "",
"ContactCity": "",
"ContactCellPhoneProvider": "",
"ContactTitle": "",
"ContactLastName": "",
"ContactState": "",
"ContactAddress": "",
"ContactCompany": "",
"GeoCode": "",
"ContactProvince": "",
"ContactHomePhone": "",
"AutoUpdateGeoCode": "0",
"ContactFax": "",
"ContactCompanyPosition": ""
},
"IntegrationId": null,
"IsDeleted": false,
"IsSystem": false,
"CreateDate": "2019-02-15T19:08:57.673",
"ModifyDate": null,
"IsLocal": true,
"AuthenticationSourcesDataId": null,
"DisplayName": "Admins",
"StartDate": "2019-02-15T19:08:37",
"EndDate": "9999-12-31T23:59:59",
"AuthenticationSourcesCredentials": null,
"DynamicRoles": false,
"GeoCode": null,
"Latitude": null,
"Longitude": null,
"AudienceIds": [
"bf7bb52f-eae7-4d5a-bd20-6849d0260c80:1:1"
],
"AudienceIntegrationIds": null,
"RoleIds": [
"5dd69f8f-f4bc-490c-87ce-22eb136ec5f8"
],
"RoleIntegrationIds": [
"Admins"
],
"cpsys_RowNum": 1
},
{
"UserId": "0d098c63-1a84-4044-8c9e-b98fc6b3608d",
"ParentUserId": null,
"UserName": "VladTest",
"Email": "vgantman@oxcyon.com",
"IsLockedOut": false,
"LastLoginDate": "2019-02-07T14:32:15.253",
"LastPasswordChangedDate": "2019-02-06T14:14:44.453",
"FailedPasswordAttemptCount": 0,
"Personalization": {
"CpGridRowSelectorPopulatesSearchWithDataKey": "0",
"PageSize": "25",
"AttributeNameFontWeight": "Bold",
"SiteTitle": "",
"VersionCompareOpenAllAttibutes": "0",
"ControlWidth": "Dynamic",
"DisplayVersion": "0",
"TimeZoneId": "Eastern Standard Time",
"DisplayTimer": "0",
"CultureName": "en-US",
"DefaultSort": "{0}.Title",
"VersionCompareShowOnlyChangedAttibutes": "1",
"DisplayPageScroller": "0",
"VersionCompareEditorComparisonAlgorithm": "1",
"VersionCompareShowHiddenAttibutes": "0",
"CpEditorHighlightCpScripting": "0",
"DisplaySavePlusNewButton": "AddNewOnly",
"AudiencesPostingMode": "Combined",
"HealthMonitorDefaultReportsType": "0",
"SourceEncodingCodePage": "65001",
"DisplaySystemNames": "0",
"CheckBoxLocation": "Left"
},
"Configuration": {
"ShowHistory": "0",
"AccountVerificationKey": "",
"OwaUsername": "",
"AuthenticationSourcesOAuthAccessTokenUtcExpireDate": "",
"OwaPassword": "",
"AccountVerified": "0",
"AuthenticationSourcesOAuthSalesforceUserInfoUrl": "",
"ViewComments": "0",
"ImportedPassword": "",
"SiteMapItems": "095ab16a-cc7a-42c3-9f43-239f7241f614",
"AuthenticationSourcesOAuthTwitterTokenSecret": "",
"PasswordChangeRequired": "0",
"OwaServer": "",
"AuthenticationSourcesOAuthAccessToken": "",
"PasswordChangeVerificationKey": "",
"SelectSiteMapItems": "0",
"AuthenticationSourcesOAuthSource": "",
"AuthenticationSourcesOAuthRefreshToken": "",
"ShowNotesBetweenEditors": "0",
"AuthenticationSourcesSamlAttributes": "",
"LoginRedirectUrl": ""
},
"Properties": {
"ContactPhoto": "",
"ContactCompanyPosition": "",
"Location": "",
"ContactHomePhone": "",
"ContactSuffix": "",
"ContactTitle": "",
"TenantsD": "",
"TenantsE": "",
"ContactCity": "",
"ContactPostalCode": "",
"TenantsC": "",
"Vendor": "",
"Manager": "",
"ContactState": "",
"TenantsA": "",
"Department_Unit": "",
"ContactMiddleName": "",
"TenantsB": "",
"ContactAddress": "",
"ContactCellPhoneProvider": "",
"ContactCompany": "",
"ContactOfficePhone": "",
"ContactCellPhone": "",
"AutoUpdateGeoCode": "0",
"GeoCode": "",
"MyLinks": "",
"ContactFax": "",
"ContactCountry": "",
"ContactLastName": "",
"ContactProvince": "",
"ContactFirstName": ""
},
"IntegrationId": "vgantman@oxcyon.com",
"IsDeleted": false,
"IsSystem": false,
"CreateDate": "2019-02-06T14:14:44.453",
"ModifyDate": "2019-08-16T14:41:50.923",
"IsLocal": true,
"AuthenticationSourcesDataId": null,
"DisplayName": "Vlad",
"StartDate": "2019-02-06T14:14:16",
"EndDate": "9999-12-31T23:59:59",
"AuthenticationSourcesCredentials": null,
"DynamicRoles": false,
"GeoCode": null,
"Latitude": null,
"Longitude": null,
"AudienceIds": [
"bad4f158-a610-459e-81f5-508058ad5095:1:0",
"3e39ef2b-3f14-4ba6-8662-5dbfd2469e94:1:1",
"5f2d099d-a0df-4e62-bb88-93662c972ae0:1:1"
],
"AudienceIntegrationIds": [
"Wellcare"
],
"RoleIds": [
"5dd69f8f-f4bc-490c-87ce-22eb136ec5f8",
"b9fe4068-2b1a-4be9-bc53-7083423024b0",
"e241c0bb-4a9c-4cf8-b2e4-7afc9e13abd8",
"a241faae-8b2f-4566-a852-c4d565da3d77",
"5135fc99-086a-4f67-95bf-df737b0c1b9f"
],
"RoleIntegrationIds": [
"Admins",
"Advertisers",
"Authors",
"Bloggers",
"BIA"
],
"cpsys_RowNum": 2
}
]
}
}