CCC API v8.4.0.0

<back to all web services

CreatePartnerAdminUser

The following routes are available for this service:
POST/api/partners/{PartnerGuid}/usersCreate a new partner level admin user in the CCC.
CreatePartnerAdminUser Parameters:
NameParameterData TypeRequiredDescription
PartnerGuidpathGuidYesPartner for which the user is created.
EmailAddressbodyStringYesEmail Address for the user.
PasswordbodyStringYesPassword for the user.
AdminUserResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
AdminUser Parameters:
NameParameterData TypeRequiredDescription
UserGuidbodyGuidNo
EmailAddressformstringNo
UserTypeGuidbodyGuidNo
CreatedOnbodyDateTimeNo
UserTypeformAdminUserEnumNo

Allowable Values

  • SuperUser
  • Partner
  • Reseller
  • Service
StatusformAdminUserStatusEnumNo

Allowable Values

  • Active
  • Disabled
PermissionsformList<string>No
RolesformList<string>No

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.

POST /api/partners/{PartnerGuid}/users HTTP/1.1 
Host: api.secure-messaging.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{
  "partnerGuid": "00000000000000000000000000000000",
  "emailAddress": "String",
  "password": "String"
}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{
  "responseStatus": {
    "errorCode": "String",
    "message": "String",
    "stackTrace": "String",
    "errors": [
      {
        "errorCode": "String",
        "fieldName": "String",
        "message": "String",
        "meta": {
          "String": "String"
        }
      }
    ],
    "meta": {
      "String": "String"
    }
  },
  "userGuid": "00000000000000000000000000000000",
  "emailAddress": "String",
  "userTypeGuid": "00000000000000000000000000000000",
  "createdOn": "0001-01-01T00:00:00Z",
  "userType": "SuperUser",
  "status": "Active",
  "permissions": [
    "String"
  ],
  "roles": [
    "String"
  ]
}