User service provides the management functions of the user profile.

On this page:

List user

Endpoint

URI	HTTP Method
https://m.thingscale.io/v2/user/	GET

Parameters

Request parameters

Request Parameter	Description:
Header:	X-APITOKEN:`API_TOKEN_HERE`
Body:	None

Response Body

User's metadata returned in JSON.

Elements	Type	Description	Max Length	API version
user_id	string	user_account	R/O	1.x/2.x
api_token	string	API_TOKEN	32bytes(auto generated)	1.x/2.x
device_token	string	DEVICE_TOKEN	32bytes(auto generated)	1.x/2.x
email1	string	notification email1	64bytes	1.x/2.x
email2	string	notification email2	64bytes	1.x/2.x
organization	string	organization name	32bytes	1.x/2.x
locale	string	timezone	32bytes	1.x/2.x
user_alias	string	alias of user_account	32bytes	1.x/2.x
storage:count	int	total records of all channels		2.x
storage:usage_bytes	int	usage of storage		2.x
storage:maxSize	int	maxSize of storage		2.x
storage:avg_obj_size	int	average of object size		2.x

sample payload

 [
    {
        "user_id": "xxxxxxxxxxxx",
        "api_token": "xxxxxxxxxxxx",
        "device_token": "xxxxxxxxxxxx",
        "email1": "name@example.com",
        "email2": "name2@example.com",
        "organization": "Sensinics,LLC",
        "locale": "Asia/Tokyo",
        "user_alias": "Toru Murasawa",
	    "storage": {
    	  	"count": 10,
      		"usage_bytes": 36864,
      		"maxSize": 5242880000,
      		"avg_obj_size": 97
    	}
    }
]

Response Code

HTTP Status code:	Description/Response Body:
`200 OK`	Transaction OK.
`401 Unauthorized`	APITOKEN is invalid or null {"error" : "AUTH_REQUIRED"}

curl example

 curl -X GET -H "X-APITOKEN: API_TOKEN_HERE" -k https://m.thingscale.io/v2/user

Update user

Endpoint

URI	HTTP Method
https://m.thingscale.io/v2/user/	PUT

Parameters

Request parameters

Request Parameter Description:

URI: https://m.thingscale.io/v2/user/

Header: X-APITOKEN:API_TOKEN_HERE

Body:

Request body is JSON payload as follows:
(NOTE)At least one field required.

sample payload

{
        "email1": "YOUR_EMAIL_ADDRESS1",
        "email2": "YOUR_EMAIL_ADDRESS2",
        "organization": "YOUR_ORGANIZATION",
        "locale": "YOUR_LOCALE(TIMEZONE)", // e.g. Asia/Tokyo (set from Management Console recommended.)
        "user_alias": "YOUR_NAME"
}

Updating API_TOKEN and DEVICE_TOKEN

You will not be able to update API token and Device token reasons API via in on security.
Please perform the re-generation of each token from the management console.

Response Code

HTTP Status code:	Description/Response Body:
`200 OK`	Transaction OK.
`401 Unauthorized`	APITOKEN is invalid or null {"error" : "AUTH_REQUIRED"}

curl example

curl -X PUT -H "X-APITOKEN: API_TOKEN_HERE" -H "Content-Type: application/json" -k -d '{"user_alias" : "James Hetfield"}' https://m.thingscale.io/v2/user