change_user

Syntax

{
    <credentials object> 
    "user": <name of user to create or change> 
    "attributes":
     {
         <key-value pairs> 
     }
     create_only: TRUE | FALSE
}

Request fields for change_user

The following fields can be used in the change_user method:

Attributes fields

You can specify the following fields within the attributes array.

Valid combinations of delivery attributes are

• delivery_local—Mail is stored locally.
• delivery_local, delivery_forward—Mail is stored locally and forwarded.
• delivery_forward—Mail is forwarded.
• delivery_local, delivery_autoresponder—Mail is stored locally, automatic reply sent.
• delivery_local, delivery_forward, delivery_autoresponder—Mail is stored locally and forwarded, automatic reply sent.
• delivery_forward, delivery_autoresponder—Mail is forwarded, automatic reply sent.
• delivery_filter—Mail is forwarded to domain-defined mail host.

📘

Note:

No matter which delivery options are set, all messages are scanned for viruses and malware, and, depending on the mailbox's allow list, all messages are scanned for spam.

📘

Password Validation

Password Validation can only occur when a plaintext password is sent as part of the API request.

A user changing their own password is subject to an additional password strength test (when req.user == req.credentials.user). Increasing the length of the password and including a mix of symbols, upper and lower case letters, and numbers will increase the calculated strength of a given password. The required minimum strength level is inherited from the password_strength attribute set at the domain, company, or cluster level.

As of V1.1, all password changes are subject to the following check:

• Contains check: any password supplied during a password update or account creation will be checked to make sure it does not contain the user's username or domain name, and if it does, the password will be rejected. This test is not case-sensitive.

📘

When creating a new user, if a service is not specified in the request, the value of the service attribute is taken from the domain setting. If the domain does not have a value for that service, it is enabled. If a service is suspended in the domain, it can only be set in the request by an admin of the same or higher level than the admin that set the service to suspended in the domain (for example, a domain admin cannot change a service that was suspended by a company admin).

Response fields for change_user

The following fields may be returned in response to the change_user method:

Examples for change_user

Example 1

Successfully creates a new user.

Request

{
  "credentials": {
		"user": "[email protected]",
    "password": "sw0rdf1sh"
  },
  "user": "[email protected]",
  "attributes": {
    "name": "Bob Hayden",
    "password": "changeit",
    "delivery_forward": true,
    "forward_recipients": [
        "[email protected]
  }
}

Response

{
   "success": true
}

Example 2

Changes the user's spamtag attribute.

Request

{
  "credentials": {
    "user": "[email protected]",
    "password": "sw0rdf1sh"
  },
  "user": "[email protected]",
  "attributes": {
    "spamtag": "[JUNK]"
  }
}

Response

{
   "success": true
}

Example 3

Attempts to modify an existing user, but fails due to badly formatted attributes.

Request

{
  "credentials": {
		"user": "[email protected]",
    "password": "sw0rdf1sh"
  },
   "user": "[email protected]",
   "attributes": {
      "spamtag": "(SPAM)",
      "name": [
				 "Robson",
				 "Wilk" 
      ],
      "allow": "[email protected]",
      "block": [
         "[email protected]",
         "*@naughty.edu"
      ]
	 } 
}

Response

{
   "success": false
   "hints": {
      "name": "Not a valid Text[1-512] (not a string)",
      "allow": "Not a list"
   },
   "error_number": 6,
   "error": "One or more attributes badly formatted" 
}

Example 4

Attempts to create a user that already exists (with create_only flag).

Request

{
  "credentials": {
  "user": "[email protected]",
    "password": "sw0rdf1sh"
  },
  "user":"[email protected]",
  "create_only":true,
  "attributes":{
    "type":"mailbox",
    "password":"gob",
    "reject_spam":false,
    "name":"Bob Hayden",
    "workgroup":"staff"
  } 
}

Response

{
  "success":false,
  "error_number":23,
  "error":"Object already exists",
  "audit":"jewel30_50c235f127"
}

Example 5

Changes a user to a filter.

Request

{
  "credentials": {
    "user": "[email protected]", 
    "password": "sw0rdf1sh"
    },
    "user":"[email protected]",
    "attributes":{
      "type":"filter"
    }
}

Response

{
   "success": true
}

Example 6

Changes a user to a forward.

Request

{
  "credentials": {
    "user": "[email protected]",
    "password": "sw0rdf1sh"
  },
  "user":"[email protected]",
  "attributes":{
    "type":"forward"
  }
}

Response

{
   "success": true
}

Example 7

Changes a user to a mailbox.

Request

{
  "credentials": {
    "user": "[email protected]",
    "password": "sw0rdf1sh"
  },
  "user":"[email protected]",
  "attributes":{
   "type":"mailbox",
   "delivery_local":true,
   "delivery_forward":false
  } 
}

Response

{
   "success": true
}

Example 8

Adds a note to a user

Request

{
  "credentials": {
    "user": "[email protected]",
    "password": "sw0rdf1sh"
  },
  "user":"[email protected]",
  "attributes":{
   "notes_external": "Premier customer.\nSpend extra time in support if they call.",
  } 
}

Response

{
   "success": true
}