CCC API v8.4.0.0

<back to all web services

SearchServiceUsers

The following routes are available for this service:
GET/api/services/usersSearch users based on a token found in either first name, last name, or email address.If ServiceGuid, CollectionGuid and SiteGuid are specified, they need to match.
SearchServiceUsers Parameters:
NameParameterData TypeRequiredDescription
ServiceGuidqueryGuidNoIf ServiceGuid is specified then the search is limited to users of that service.
CollectionGuidqueryGuidNoIf CollectionGuid is specified then the search is limited to users of services in that collection.
SiteGuidqueryGuidNoIf SiteGuid is specified then the search is limited to users of services in that site.
TokenqueryStringYesThe search term is case insensitive.
SearchServiceUsersResponse Parameters:
NameParameterData TypeRequiredDescription
ResultsbodySearchServiceUserResult[]No
ResponseStatusformResponseStatusNo
SearchServiceUserResult Parameters:
NameParameterData TypeRequiredDescription
ServiceUserbodyServiceUserNo
ServicebodyServiceNo
ServiceUser Parameters:
NameParameterData TypeRequiredDescription
ServiceUserGuidbodyGuidNo
EmailAddressformstringNo
CreatedOnbodyDateTimeNo
FirstNameformstringNo
LastNameformstringNo
StatusformstringNo

Allowable Values

  • Active
  • Disabled
RegisteredOnbodyDateTimeNo
PackageExpirybodyDateTimeNo
LanguageformstringNo

Allowable Values

  • en
  • fr
  • de
  • es
  • ja
  • nl
  • zh
EmailAliasesformDictionary<string, string>No
GroupNameformstringNo
GroupGuidbodyGuidNo
GroupTypeformstringNo

Allowable Values

  • Guest
  • Professional
EnableCampaignsformboolNo

Allowable Values

  • true
  • false
EnableESignaturesformboolNo

Allowable Values

  • true
  • false
LastLoginbodyDateTimeNo
LastIpAddressformstringNo
CurrentToolbarVersionformstringNo
PasswordExpiryformDateTime?No
PasswordThrottledformboolNo
DefaultSecureformstringNo

Allowable Values

  • Never
  • BasedOnKeywords
  • Always
BlacklistModeformstringNo

Allowable Values

  • Never
  • SecureOnly
  • SecureAndBasic
EnableMfaformboolNo

Allowable Values

  • true
  • false
Service Parameters:
NameParameterData TypeRequiredDescription
ServiceGuidbodyGuidNo
NameformstringNo
StatusformServiceStatusNo

Allowable Values

  • Blocked
  • AccountCancelled
  • AccountSuspended
  • Provisioning
  • TrialExpired
  • TrialActive
  • DemoAccount
  • CertifiedSecure
ServiceCodeformstringNo
ReferenceIdformstringNo
PrimaryDomainformstringNo
UrlsformDictionary<ServiceUrlType, string>No

Allowable Values

  • MessagingApi
  • Webmail
  • ToolbarServices
  • GatewaySettings
  • AdminConsole
  • SecMsgAPI
  • Webapp
  • IdProxy
  • IdProxyLogout
CreatedOnbodyDateTimeNo
TrialEndDatebodyDateTimeNo
EffectiveDatebodyDateTimeNo
InitialTermbodyIntegerNo
CollectionGuidbodyGuidNo
SiteGuidbodyGuidNo
ClientGuidbodyGuidNo
ResellerGuidbodyGuidNo
ResellerNameformstringNo
PartnerGuidbodyGuidNo
PartnerNameformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /api/services/users HTTP/1.1 
Host: api.secure-messaging.com 
Accept: application/json

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{
  "results": [
    {
      "serviceUser": {
        "serviceUserGuid": "00000000000000000000000000000000",
        "emailAddress": "String",
        "createdOn": "0001-01-01T00:00:00Z",
        "firstName": "String",
        "lastName": "String",
        "status": "String",
        "registeredOn": "0001-01-01T00:00:00Z",
        "packageExpiry": "0001-01-01T00:00:00Z",
        "language": "String",
        "emailAliases": {
          "String": "String"
        },
        "groupName": "String",
        "groupGuid": "00000000000000000000000000000000",
        "groupType": "String",
        "enableCampaigns": false,
        "enableESignatures": false,
        "lastLogin": "0001-01-01T00:00:00Z",
        "lastIpAddress": "String",
        "currentToolbarVersion": "String",
        "passwordExpiry": "0001-01-01T00:00:00Z",
        "passwordThrottled": false,
        "defaultSecure": "String",
        "blacklistMode": "String",
        "enableMfa": false
      },
      "service": {
        "serviceGuid": "00000000000000000000000000000000",
        "name": "String",
        "status": "Blocked",
        "serviceCode": "String",
        "referenceId": "String",
        "primaryDomain": "String",
        "urls": {
          "MessagingApi": "String"
        },
        "createdOn": "0001-01-01T00:00:00Z",
        "trialEndDate": "0001-01-01T00:00:00Z",
        "effectiveDate": "0001-01-01T00:00:00Z",
        "initialTerm": 0,
        "collectionGuid": "00000000000000000000000000000000",
        "siteGuid": "00000000000000000000000000000000",
        "clientGuid": "00000000000000000000000000000000",
        "resellerGuid": "00000000000000000000000000000000",
        "resellerName": "String",
        "partnerGuid": "00000000000000000000000000000000",
        "partnerName": "String"
      }
    }
  ],
  "responseStatus": {
    "errorCode": "String",
    "message": "String",
    "stackTrace": "String",
    "errors": [
      {
        "errorCode": "String",
        "fieldName": "String",
        "message": "String",
        "meta": {
          "String": "String"
        }
      }
    ],
    "meta": {
      "String": "String"
    }
  },
  "serviceUser": {
    "serviceUserGuid": "00000000000000000000000000000000",
    "emailAddress": "String",
    "createdOn": "0001-01-01T00:00:00Z",
    "firstName": "String",
    "lastName": "String",
    "status": "String",
    "registeredOn": "0001-01-01T00:00:00Z",
    "packageExpiry": "0001-01-01T00:00:00Z",
    "language": "String",
    "emailAliases": {
      "String": "String"
    },
    "groupName": "String",
    "groupGuid": "00000000000000000000000000000000",
    "groupType": "String",
    "enableCampaigns": false,
    "enableESignatures": false,
    "lastLogin": "0001-01-01T00:00:00Z",
    "lastIpAddress": "String",
    "currentToolbarVersion": "String",
    "passwordExpiry": "0001-01-01T00:00:00Z",
    "passwordThrottled": false,
    "defaultSecure": "String",
    "blacklistMode": "String",
    "enableMfa": false
  },
  "service": {
    "serviceGuid": "00000000000000000000000000000000",
    "name": "String",
    "status": "Blocked",
    "serviceCode": "String",
    "referenceId": "String",
    "primaryDomain": "String",
    "urls": {
      "MessagingApi": "String"
    },
    "createdOn": "0001-01-01T00:00:00Z",
    "trialEndDate": "0001-01-01T00:00:00Z",
    "effectiveDate": "0001-01-01T00:00:00Z",
    "initialTerm": 0,
    "collectionGuid": "00000000000000000000000000000000",
    "siteGuid": "00000000000000000000000000000000",
    "clientGuid": "00000000000000000000000000000000",
    "resellerGuid": "00000000000000000000000000000000",
    "resellerName": "String",
    "partnerGuid": "00000000000000000000000000000000",
    "partnerName": "String"
  }
}