KB Article #178783

REST API: Usage of the 'users' resource in ST 5.3.1 and earlier

Problem

The REST API implementation in ST 5.3.1 and older versions can be misleading, since there are two resources included in its schema: user and users. The API documentation available at


https://X.X.X.X:444/api/v1.3/docs/index.html


is vague and doesn't explain in details the usage of the resources and their differences.


Resolution

Short description and usage:


A POST request to


/accounts/{accountName}/users


will be used to create users for an account entity. Note that in this version of the API only one user per account is allowed.


A POST request to


/accounts/{accountName}/users/{userName}


will be used to update the properties of an existing user of an account entity.


Additional note: The documentation available in ST 5.3.6 has been updated and now covers the usage of the resources.