V-Spark Online Help

Differences between GET and POST JSON for the /config/users API

The /config/users API supports additional name/value pairs that can be used as part of your JSON input when programmatically creating user accounts. These fields are in addition to those shown in Sample /config/users JSON Output for a User:

Table 1. /config/users Fields

Name

Type

Values

Description

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.

Figure 1. Sample User JSON Including a Password Field
{
  "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.



Important

When creating a user account that will be integrated with an external authorization mechanism, the Username for the account that you are creating must be the same in V‑Spark as it is in the external authorization mechanism. This username may be a simple username, an email address, or a "user principle name" (UPN), depending on the service.

The additional name/value pair(s) discussed in the previous list can also be used in JSON input that is provided to calls to the /config/CO-SHORT/users API. The primary difference between the JSON that is provided in calls to that API and to the /config/users API is the JSON that is provided in calls to the /config/users API must specify the company under which each user is to be created.