Update User Detail
"This endpoint allows users to update their details within your organisation, including given name, surname, and display name, while ensuring email remains unchanged. It integrates with internal authentication systems and external identity providers to maintain security and consistency. By providing a secure and efficient way to manage user information, organisations can enhance personalisation, streamline communication, and optimise identity management across various platforms."
Syntax: see 'CCall Structure
Type = 'PATCH'
|
'https://connect.cambrionix.com/api/v1/user/detail' |
In the data section of the request, include the information you wish to add, formatted as shown below.
|
{ "givenName": "given-name", "surname": "surname", "displayName": "display-name" } |
| Variable | Description |
|---|---|
| given-name | The first name of the user |
| surname | The surname of the user |
| display-name | The account name of the user |
Returns:
|
{ "created": { "time": time }, "updated":{ "time": time "user": { "id": "user-id", "detail": { "givenName": "given-name", "surname": "surname", "displayName": "display-name", "email": "account-email" } } }, "id": "user-id", "detail": { "givenName": "given-name", "surname": "surname", "displayName": "display-name", "email": "account-email" }, "organizations": [ { "id": "organisation-id", "name": "organisation-name", "license": { "id": "license-id", "name": "license-name", "features": [ { "template": { "id": "feature-id", "name": "feature-name", "schema": { "type": "schema-type", "properties": { "Maximum Users": maximum-users } } }, "metadata": { "Maximum Users": maximum-users } } ] } } ], "settings": { "activeOrganization": { "id": "organisation-id" }, "defaultOrganization": { "id": "organisation-id" }, "showInitialOnboarding": new-user, "notifications": { "disconnection": notification-status, "rfid": notification-status, "update": notification-status, "firmware": notification-status }, "personalization": { "theme": "theme-preference", "units": { "temperature": "temperature-preference", "memory": "memory-preference" } } }, "organization": { "id": "organisation-id", "name": "organisation-name" } } } } |
| Output | Description |
|---|---|
| time | The hub time, shown as an integer in ms |
| user-id | This is the id of the user as a unique 128-bit number |
| given-name | The first name of the user |
| surname | The surname of the user |
| display-name | The account name of the user |
| account-email | The email of the user |
| organisation-id | This is the unique id of the organisation as a unique 128-bit number |
| organisation-name | This is the name of the organisation |
| license-id | This is the unique id of the organisation as a unique 128-bit number |
| license-name | This is the name of license |
| feature-id | This is the unique id of the feature as a unique 128-bit number |
| feature-name | This is the name of feature |
| schema-type | This is the type of Schema for the event see Schema Types |
| maximum-users | This is the maximum amount of users for this feature |
| new-user | Is the user new "true" or not "false" |
| notification-status | Is the user signed up for notification "true" or not "false" |
| theme-preference | The users display theme preference |
| temperature-preference | The users temperature display preference |
| memory-preference | The users memory display preference |
Example
curl -X 'PATCH' \
'https://connect.cambrionix.com/api/v1/user/detail' \
-H 'accept: application/json' \
-H 'Authorization: Bearer eyJhbG0obccfQsLYVz8JpCHA' \
-H 'Content-Type: application/json' \
-d '{
"givenName": "Nick",
"surname": "Metcalfe",
"displayName": "Nick Metcalfe"
}'Returns
{
"result": {
"created": {
"time": 1718280785210
},
"updated": {
"time": 1739280295143,
"user": {
"id": "46bbf7f5-1794-411d-b42b-97ab2fe12460",
"detail": {
"givenName": "Nick",
"surname": "Metcalfe",
"displayName": "Nick Metcalfe",
"email": "nicholas.metcalfe@cambrionix.com"
}
}
},
"id": "46bbf7f5-1794-411d-b42b-97ab2fe12460",
"detail": {
"givenName": "Nick",
"surname": "Metcalfe",
"displayName": "Nick Metcalfe",
"email": "nicholas.metcalfe@cambrionix.com"
},
"organizations": [
{
"id": "95328aa6-2267-4bd6-91b4-b53d6d4a8391",
"name": "Professional license connect test platform",
"license": {
"id": "ae387efd-8b53-417b-a2a2-bc7beb7fe067",
"name": "Professional",
"features": [
{
"template": {
"id": "00000000-0000-0000-0000-000000000002",
"name": "Users",
"schema": {
"type": "object",
"properties": {
"Maximum Users": {
"type": "number",
"default": 10
}
},
"default": {
"Maximum Users": 10
}
}
},
"metadata": {
"Maximum Users": 100
}
}
......
],
"valid": {
"start": 1695337200000,
"end": 1726959600000
},
"created": {
"time": 1695373785656,
"user": {
"id": "46bbf7f5-1794-411d-b42b-97ab2fe12460"
}
},
"updated": {
"time": 1718279826641
}
},
"owner": {
"id": "67d60e3b-610a-4dd5-92ca-406273614700"
}
},
{
"id": "40f5a1a7-3119-4961-8493-866c4053b7eb",
"name": "Premium license connect test platform"
},
{
"id": "f5137b5e-1786-4e62-9f6f-5cf5cf24a37f",
"name": "Nick's Test Org"
}
],
"accounts": [
{
"id": "46bbf7f5-1794-411d-b42b-97ab2fe12460"
},
{
"id": "bcf5a671-86a8-40e3-96ce-b094956eb534"
}
],
"settings": {
"activeOrganization": {
"id": "40f5a1a7-3119-4961-8493-866c4053b7eb"
},
"defaultOrganization": {
"id": "fe783079-434f-412d-b312-d783c76a83e2"
},
"showInitialOnboarding": false,
"notifications": {
"disconnection": true,
"rfid": true,
"update": true,
"firmware": true
},
"personalization": {
"theme": "Light",
"units": {
"temperature": "Celsius",
"memory": "Binary"
}
}
}
}
}Errors
If there is an error in the API method then JSON-RPC Error Object a will be returned