password

Enables you to specify the password that will be assigned to a user account when it is created. An example of specifying a password using this field is the following:

"password": "changeme",

If the password field is not included in the auth section of the JSON for a user, a reset password link will be emailed to the new user. The sample JSON below is for a user who has system administration permissions for their home company (DocTestCo, in this case) and has a default password of changeme. See V‑Spark Permissions and the /config/users API for a discussion of user permissions and roles in the API.

{
  "test.user.02": {
    "name": "Company-Level Administrator",
    "email": "test.user.02@example.com",
    "company": "DocTestCo",
    "auth": {
      "verified": true,
      "disabled": false,
      "method": "standard",
      "password": "changeme"
    },
    "permissions": {
      "DocTestCo": {
        "all": [
          "read",
          "write"
        ]
      }
    }
  }
},...

method

standard, ldap

Enables you to specify the authorization method that will be used to verify the user's identity when they log in.

Set to "standard" for internal V‑Spark authorization

Set to "ldap" For external authorization through a Lightweight Directory Access Protocol server such as Microsoft Active Directory.

This option is only useful when you are creating a new account. Once the user's authorization method has been set, it cannot be changed.