The PUT /api/users/{userId} endpoint allows you to update the information of a specific user registered in the system. It is used to modify the user details, such as name, email, country, time zone, and other relevant attributes. This endpoint is useful for system administrators who need to keep user information up-to-date.
This endpoint is especially beneficial for applications that allow user management and administration, providing the capability to update specific user data.
Request Details
HTTP Method: PUT
URL: /api/users/{userId}
Request Parameters
| Parameter |
Type |
Required |
Description |
| userId |
string |
Yes |
The unique identifier of the user. |
Request Body Parameters
The request body should be a JSON object with the following fields:
| Field |
Type |
Required |
Description |
| name |
string |
Yes |
The name of the user. |
| email |
string |
Yes |
The email address of the user. |
| country |
string |
Yes |
The country of the user. |
| timeZone |
string |
Yes |
The time zone of the user. |
| description |
string |
No |
A description of the user. |
| message |
string |
No |
A message associated with the user. |
| disabled |
boolean |
No |
Indicates whether the user is disabled. |
| disabledMessage |
string |
No |
A message describing why the user is disabled. |
| tags |
object |
No |
A set of tags associated with the user. |
| privileges |
array |
No |
A list of privileges for the user. |
| group |
string |
No |
The group to which the user belongs. |
| deviceId |
string |
No |
The identifier of the user's device. |
| adminDevices |
integer |
No |
The number of devices managed by the user. |
| from |
string |
No |
The start date and time of the user's activity. |
| expires |
string |
No |
The expiration date and time of the user. |
| password |
string |
No |
The user's password (must be encrypted). |
| creation |
string |
No |
The date and time the user was created. (This field is typically system-generated.) |
| modification |
string |
No |
The date and time of the user's last modification. (This field is typically system-generated.) |
| lastLogin |
string |
No |
The date and time of the user's last login. |
Authentication required to use the endpoint is via a Bearer token. This authentication method implies that each request must include an authorization header with a valid access token. This Bearer token acts as a credential that verifies the identity of the user or application making the request, ensuring that only authorized entities can modify the user's information. By requiring this type of authentication, the ALTAGAMA GPS system guarantees a high level of security and access control, protecting users' data against unauthorized access.
Example Request
PUT /api/users/12345 HTTP/1.1
Host: api.plaspy.com
Content-Type: application/json
Authorization: Bearer {your_auth_token}
{
"name": "Jane Doe",
"email": "jane.doe@example.com",
"country": "USA",
"timeZone": "America/Los_Angeles",
"description": "Updated user for the marketing department",
"tags": {
"role": "user",
"department": "marketing"
},
"privileges": ["read", "write"],
"group": "Marketing",
"deviceId": "dev-12345",
"adminDevices": 2,
"from": "2023-01-01T00:00:00Z",
"expires": "2024-01-01T00:00:00Z",
"password": "P@ssw0rd123",
"creation": "2023-01-01T00:00:00Z",
"modification": "2023-06-01T00:00:00Z",
"lastLogin": "2024-05-01T00:00:00Z"
}
Response Parameters
The response from this endpoint includes the details of the updated user or an error message if the request was not successful.
| Field |
Type |
Required |
Description |
| success |
boolean |
No |
Indicates whether the request was successful. |
| error |
string |
No |
Contains the error message if success is false. |
| apiUsage |
integer |
No |
Current API usage by the user. |
| apiDailyUsage |
integer |
No |
Daily API usage by the user. |
| id |
string |
No |
Unique identifier of the updated user. |
| name |
string |
Yes |
Name of the updated user. |
| email |
string |
Yes |
Email of the updated user. |
| country |
string |
Yes |
Country of the updated user. |
| timeZone |
string |
Yes |
Time zone of the updated user. |
| description |
string |
No |
Description of the updated user. |
| message |
string |
No |
Message associated with the updated user. |
| disabled |
boolean |
No |
Indicates whether the updated user is disabled. |
| disabledMessage |
string |
No |
Message describing why the updated user is disabled. |
| tags |
object |
No |
Set of tags associated with the updated user. |
| privileges |
array |
No |
List of privileges of the updated user. |
| group |
string |
No |
Group to which the updated user belongs. |
| deviceId |
string |
No |
Identifier of the updated user's device. |
| adminDevices |
integer |
No |
Number of devices managed by the updated user. |
| from |
string |
No |
Start date and time of the updated user's activity. |
| expires |
string |
No |
Expiration date and time of the updated user. |
| password |
string |
No |
Password of the updated user (encrypted). |
| creation |
string |
No |
Date and time the updated user was created. |
| modification |
string |
No |
Date and time of the updated user's last modification. |
| lastLogin |
string |
No |
Date and time of the updated user's last login. |
Example Successful Response
{
"success": true,
"apiUsage": 150,
"apiDailyUsage": 15,
"id": "usr-12345",
"name": "Jane Doe",
"email": "jane.doe@example.com",
"country": "USA",
"timeZone": "America/Los_Angeles",
"description": "Updated user for the marketing department",
"tags": {
"role": "user",
"department": "marketing"
},
"privileges": ["read", "write"],
"group": "Marketing",
"deviceId": "dev-12345",
"adminDevices": 2,
"from": "2023-01-01T00:00:00Z",
"expires": "2024-01-01T00:00:00Z",
"password": null,
"creation": "2023-01-01T00:00:00Z",
"modification": "2023-06-01T00:00:00Z", "lastLogin": "2024-05-01T00:00:00Z" }