V-Spark Online Help

Sample /config/users JSON Output for a User

Important

Users are defined within companies, and are therefore deleted when the company that they are associated with is deleted.

This excerpt is sample JSON output for a single user from the /config/users API.

Figure 1. Sample User Information from the /config/users API
"Testing": {
    "joe.user": {
        "auth": {
            "disabled": false,
            "verified": true,
            "method": "standard"
        },
        "company": "Testing",
        "email": "joeuser@example.com",
        "name": "Joe User",
        "permissions": {
            "DocTestCo": {
                "all": [
                    "read",
                    "write"
                ]
            },
            "Testing": {
                "all": [
                    "read"
                ],
                "orgs": {
                    "Testing-CallbackTest": [
                        "write"
                    ],
                    "Testing-ApplicationTesting": [
                        "write"
                    ]
                }
            }
        }
    }
}...


The identifier for each user account object is the username that identifies this account. When creating new user accounts, keep in mind that the username for each user in V‑Spark must be unique to the V‑Spark installation.

Table 1. /config/users Fields

Name

Type

Values

Description

auth

NA

The authorization status of this account and authentication method used to verify the identity of the user when they log in.

"auth": {
    "disabled": false,
    "verified": true,
    "method": "standard",
    "password": "4s+7yaRf"
},

disabled

Boolean

true, false

Either "false," denoting an active account, or "true," denoting an account that has been disabled or has not yet been enabled after creation.

verified

Boolean

true, false

Either "false," denoting a requested account that has not yet been approved, or "true," denoting an account that has been verified and approved by a System or Company admin.

method

true, false

How the user's identity will be authenticated when they log in. A value of "standard" indicates that internal V‑Spark authentication is used. Any other value indicates the integrated authentication method that should be used.

password

String

Only be provided when creating a new account with standard authentication. This value will serve as the account's initial password.

company

String

REQUIRED when creating a new account. The short name of the company within which this account exists.

"company": "Testing",

email

String

REQUIRED when creating a new account. The fully qualified email address associated with this account.

The email address for each user in V‑Spark must be unique to the V‑Spark installation.

"email": "joeuser@example.com",

name

String

REQUIRED when creating a new account. The name of the person who uses this account.

"name": "Joe User",

permissions

Permissions that this user account has for the companies and organizations in the V‑Spark installation. For detailed information about user permissions, see Permissions and Capabilities in the /config/users API

In the following example, the user account has read and write permissions to all organizations within the "DocTestCo" company, read permissions to all organizations within the "Testing" company, and additional write permissions to the "CallbackTest" and "ApplicationTesting" organizations that are within the "Testing" company.

"permissions": {
    "DocTestCo": {
        "all": [
            "read",
            "write"
        ]
    },
    "Testing": {
        "all": [
            "read"
        ],
        "orgs": {
            "Testing-CallbackTest": [
                "write"
            ],
            "Testing-ApplicationTesting": [
                "write"
            ]
        }
    }
}


The output shown in the previous excerpt is very similar to the first part of the output that you would have received had you called the /config/TestCompany/users API on a V‑Spark installation where the "Test Company, Inc." company (with the company short name, "Testcompany") had been defined. The call would have returned JSON, which only differs from the previous excerpt in that it does not need to identify the short name of the company that it refers to, since you have specified that value in the URL.

The identifier for each user account object is the username that identifies this account. When creating new user accounts, keep in mind that the username for each user in V‑Spark must be unique to the V‑Spark installation.

Figure 2. Sample User output from the /config/CO_SHORT/users API
{
    "joe.user": {
        "company": "Testing",
        "email": "joe.user@company.com",
        "name": "Joe User",
        "auth": {
            "disabled": false,
            "verified": true,
            "method": "standard"
        },
        "permissions": {
            "DocTestCo": {
                "all": [
                   "read",
                   "write"
                ]
            },
        },...
    }
}