User v1.2

User provides details about the users on your Sign-Up.to account. You will always have one admin user and potentially additional sub-users.

This endpoint also has a partner-auth version.

What can I do with user?

Retrieve various statistics and information on your account users. This can be useful for checking activity or looking up user details.

  • Look up a user's lastlogon to find out the last time they accessed the account.
  • Find a user's contact and personal details filtering by currentuser or username.
  • The currentuser attribute can be useful for ascertaining the authenticated user's isadmin status.
  • Find out if the user is locked out of an account (through failed login attempts) using locked.

In all cases, a user's password is write-only. The attribute will be returned as "null".

GET /user or /user/:id

AttributeTypeFilterSortDescription
id
intYesYesUnique ID of the user.
active
boolNoNoWhether the user is active.
currentuser
boolYesNoWhether the user is the current user making the request.
email
stringNoNoThe user's email address.
firstname
stringNoNoThe user's first name.
isadmin
boolNoNoWhether the user is the admin user.
lastlogon
int/nullNoNoTimestamp of when the user last logged into the online platform.
locked
boolNoNoBoolean (triggered by the user failing 3 login attempts in a row).
logins
intNoNoTotal number of logins the user has made.
msisdn
string/nullNoNoMobile number for the user.
password
string/nullNoNoThe user's password (at least seven characters with both letters and numbers).
lastname
stringNoNoThe user's last name (surname).
username
stringYesNoThe username for the user.
timezone
stringNoNoThe user's timezone.
cdate
decimalNoYesCreation timestamp.
mdate
decimalNoNo

Last modification timestamp.

Admin users can access all user data. Sub-users are only permitted to retrieve their own user data.

HEAD /user or /user/:id

AttributeTypePresenceDescription
id
intOptionalUnique ID of the user.
currentuser
boolOptionalWhether the user is the current user making the request.
username
stringOptionalThe username for the user.

POST /user

AttributeTypePresenceDescription
active
boolOptionalWhether the user is active.
email
stringRequiredThe user's email address.
firstname
stringRequiredThe user's first name.
msisdn
string/nullOptionalMobile number for the user.
password
string/nullRequiredThe user's password (at least seven characters with both letters and numbers).
lastname
stringRequiredThe user's last name (surname).
username
stringRequiredThe username for the user.

Admin users can create new users.

PUT /user or /user/:id

AttributeTypePresenceDescription
id
intRequiredUnique ID of the user.
active
boolOptionalWhether the user is active.
email
stringOptionalThe user's email address.
firstname
stringOptionalThe user's first name.
msisdn
string/nullOptionalMobile number for the user.
password
string/nullOptionalThe user's password (at least seven characters with both letters and numbers).
lastname
stringOptionalThe user's last name (surname).
username
stringOptionalThe username for the user.

Admin users can modify other users. Sub-users are only permitted to modify their own user data.

DELETE /user or /user/:id

AttributeTypePresenceDescription
id
intRequiredUnique ID of the user.

Admin users can remove other users, but not themselves.

Error codes

There are no error codes for this endpoint.

Examples

JSON response

{
    "id":          12345,
    "active":      true,
    "currentuser": false,
    "email":       "jane.doe@example.com",
    "firstname":   "Jane",
    "isadmin":     false,
    "lastlogon":   133309876,
    "lastname":     "Doe",
    "locked":      false,
    "logins":      3,
    "msisdn":      "447777777777",
    "password":    "f$g5lsG5ghf!",
    "username":    "jane123",
    "timezone":    "Europe/London",
    "cdate":       1234966741,
    "mdate":       1234966741
}