Update User
curl --request PUT \
--url https://api.masternautconnect.com/connect-webservices/services/public/v1/customer/{customerId}/user/{userId} \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json;charset=UTF-8' \
--data '
{
"id": "<string>",
"customerId": "<string>",
"userName": "<string>",
"externalIdentifier": "<string>",
"fullName": "<string>",
"emailAddress": "<string>",
"language": {
"language": "<string>",
"script": "<string>",
"variant": "<string>",
"displayName": "<string>",
"country": "<string>",
"unicodeLocaleAttributes": [
"<string>"
],
"unicodeLocaleKeys": [
"<string>"
],
"displayLanguage": "<string>",
"displayScript": "<string>",
"displayCountry": "<string>",
"displayVariant": "<string>",
"extensionKeys": [
"<string>"
],
"iso3Language": "<string>",
"iso3Country": "<string>"
},
"timezone": "<string>",
"roleId": "<string>",
"roleName": "<string>",
"groupId": "<string>",
"groupName": "<string>",
"unitPreferences": {},
"sendWelcomeEmail": true,
"secondaryGroups": [
{
"id": "<string>",
"name": "<string>"
}
]
}
'import requests
url = "https://api.masternautconnect.com/connect-webservices/services/public/v1/customer/{customerId}/user/{userId}"
payload = {
"id": "<string>",
"customerId": "<string>",
"userName": "<string>",
"externalIdentifier": "<string>",
"fullName": "<string>",
"emailAddress": "<string>",
"language": {
"language": "<string>",
"script": "<string>",
"variant": "<string>",
"displayName": "<string>",
"country": "<string>",
"unicodeLocaleAttributes": ["<string>"],
"unicodeLocaleKeys": ["<string>"],
"displayLanguage": "<string>",
"displayScript": "<string>",
"displayCountry": "<string>",
"displayVariant": "<string>",
"extensionKeys": ["<string>"],
"iso3Language": "<string>",
"iso3Country": "<string>"
},
"timezone": "<string>",
"roleId": "<string>",
"roleName": "<string>",
"groupId": "<string>",
"groupName": "<string>",
"unitPreferences": {},
"sendWelcomeEmail": True,
"secondaryGroups": [
{
"id": "<string>",
"name": "<string>"
}
]
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json;charset=UTF-8"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {
Authorization: 'Basic <encoded-value>',
'Content-Type': 'application/json;charset=UTF-8'
},
body: JSON.stringify({
id: '<string>',
customerId: '<string>',
userName: '<string>',
externalIdentifier: '<string>',
fullName: '<string>',
emailAddress: '<string>',
language: {
language: '<string>',
script: '<string>',
variant: '<string>',
displayName: '<string>',
country: '<string>',
unicodeLocaleAttributes: ['<string>'],
unicodeLocaleKeys: ['<string>'],
displayLanguage: '<string>',
displayScript: '<string>',
displayCountry: '<string>',
displayVariant: '<string>',
extensionKeys: ['<string>'],
iso3Language: '<string>',
iso3Country: '<string>'
},
timezone: '<string>',
roleId: '<string>',
roleName: '<string>',
groupId: '<string>',
groupName: '<string>',
unitPreferences: {},
sendWelcomeEmail: true,
secondaryGroups: [{id: '<string>', name: '<string>'}]
})
};
fetch('https://api.masternautconnect.com/connect-webservices/services/public/v1/customer/{customerId}/user/{userId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.masternautconnect.com/connect-webservices/services/public/v1/customer/{customerId}/user/{userId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'id' => '<string>',
'customerId' => '<string>',
'userName' => '<string>',
'externalIdentifier' => '<string>',
'fullName' => '<string>',
'emailAddress' => '<string>',
'language' => [
'language' => '<string>',
'script' => '<string>',
'variant' => '<string>',
'displayName' => '<string>',
'country' => '<string>',
'unicodeLocaleAttributes' => [
'<string>'
],
'unicodeLocaleKeys' => [
'<string>'
],
'displayLanguage' => '<string>',
'displayScript' => '<string>',
'displayCountry' => '<string>',
'displayVariant' => '<string>',
'extensionKeys' => [
'<string>'
],
'iso3Language' => '<string>',
'iso3Country' => '<string>'
],
'timezone' => '<string>',
'roleId' => '<string>',
'roleName' => '<string>',
'groupId' => '<string>',
'groupName' => '<string>',
'unitPreferences' => [
],
'sendWelcomeEmail' => true,
'secondaryGroups' => [
[
'id' => '<string>',
'name' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json;charset=UTF-8"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.masternautconnect.com/connect-webservices/services/public/v1/customer/{customerId}/user/{userId}"
payload := strings.NewReader("{\n \"id\": \"<string>\",\n \"customerId\": \"<string>\",\n \"userName\": \"<string>\",\n \"externalIdentifier\": \"<string>\",\n \"fullName\": \"<string>\",\n \"emailAddress\": \"<string>\",\n \"language\": {\n \"language\": \"<string>\",\n \"script\": \"<string>\",\n \"variant\": \"<string>\",\n \"displayName\": \"<string>\",\n \"country\": \"<string>\",\n \"unicodeLocaleAttributes\": [\n \"<string>\"\n ],\n \"unicodeLocaleKeys\": [\n \"<string>\"\n ],\n \"displayLanguage\": \"<string>\",\n \"displayScript\": \"<string>\",\n \"displayCountry\": \"<string>\",\n \"displayVariant\": \"<string>\",\n \"extensionKeys\": [\n \"<string>\"\n ],\n \"iso3Language\": \"<string>\",\n \"iso3Country\": \"<string>\"\n },\n \"timezone\": \"<string>\",\n \"roleId\": \"<string>\",\n \"roleName\": \"<string>\",\n \"groupId\": \"<string>\",\n \"groupName\": \"<string>\",\n \"unitPreferences\": {},\n \"sendWelcomeEmail\": true,\n \"secondaryGroups\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json;charset=UTF-8")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.masternautconnect.com/connect-webservices/services/public/v1/customer/{customerId}/user/{userId}")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json;charset=UTF-8")
.body("{\n \"id\": \"<string>\",\n \"customerId\": \"<string>\",\n \"userName\": \"<string>\",\n \"externalIdentifier\": \"<string>\",\n \"fullName\": \"<string>\",\n \"emailAddress\": \"<string>\",\n \"language\": {\n \"language\": \"<string>\",\n \"script\": \"<string>\",\n \"variant\": \"<string>\",\n \"displayName\": \"<string>\",\n \"country\": \"<string>\",\n \"unicodeLocaleAttributes\": [\n \"<string>\"\n ],\n \"unicodeLocaleKeys\": [\n \"<string>\"\n ],\n \"displayLanguage\": \"<string>\",\n \"displayScript\": \"<string>\",\n \"displayCountry\": \"<string>\",\n \"displayVariant\": \"<string>\",\n \"extensionKeys\": [\n \"<string>\"\n ],\n \"iso3Language\": \"<string>\",\n \"iso3Country\": \"<string>\"\n },\n \"timezone\": \"<string>\",\n \"roleId\": \"<string>\",\n \"roleName\": \"<string>\",\n \"groupId\": \"<string>\",\n \"groupName\": \"<string>\",\n \"unitPreferences\": {},\n \"sendWelcomeEmail\": true,\n \"secondaryGroups\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.masternautconnect.com/connect-webservices/services/public/v1/customer/{customerId}/user/{userId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json;charset=UTF-8'
request.body = "{\n \"id\": \"<string>\",\n \"customerId\": \"<string>\",\n \"userName\": \"<string>\",\n \"externalIdentifier\": \"<string>\",\n \"fullName\": \"<string>\",\n \"emailAddress\": \"<string>\",\n \"language\": {\n \"language\": \"<string>\",\n \"script\": \"<string>\",\n \"variant\": \"<string>\",\n \"displayName\": \"<string>\",\n \"country\": \"<string>\",\n \"unicodeLocaleAttributes\": [\n \"<string>\"\n ],\n \"unicodeLocaleKeys\": [\n \"<string>\"\n ],\n \"displayLanguage\": \"<string>\",\n \"displayScript\": \"<string>\",\n \"displayCountry\": \"<string>\",\n \"displayVariant\": \"<string>\",\n \"extensionKeys\": [\n \"<string>\"\n ],\n \"iso3Language\": \"<string>\",\n \"iso3Country\": \"<string>\"\n },\n \"timezone\": \"<string>\",\n \"roleId\": \"<string>\",\n \"roleName\": \"<string>\",\n \"groupId\": \"<string>\",\n \"groupName\": \"<string>\",\n \"unitPreferences\": {},\n \"sendWelcomeEmail\": true,\n \"secondaryGroups\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body/user
Update User
PUT request to update an existing user. This is a partial update and only those values specified will be updated.
You cannot use this endpoint to update the username or the password for an existing user. To update the password you must first get a token from the Password Reset Token endpoint and then use that token with the Set User Password endpoint.
If a value for externalIdentifier is specified, then
- the user will be enabled for SSO
- the existing password for the user will be removed
- if the user had been enabled for “Connect using Google” this feature will be removed
PUT
/
public
/
v1
/
customer
/
{customerId}
/
user
/
{userId}
Update User
curl --request PUT \
--url https://api.masternautconnect.com/connect-webservices/services/public/v1/customer/{customerId}/user/{userId} \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json;charset=UTF-8' \
--data '
{
"id": "<string>",
"customerId": "<string>",
"userName": "<string>",
"externalIdentifier": "<string>",
"fullName": "<string>",
"emailAddress": "<string>",
"language": {
"language": "<string>",
"script": "<string>",
"variant": "<string>",
"displayName": "<string>",
"country": "<string>",
"unicodeLocaleAttributes": [
"<string>"
],
"unicodeLocaleKeys": [
"<string>"
],
"displayLanguage": "<string>",
"displayScript": "<string>",
"displayCountry": "<string>",
"displayVariant": "<string>",
"extensionKeys": [
"<string>"
],
"iso3Language": "<string>",
"iso3Country": "<string>"
},
"timezone": "<string>",
"roleId": "<string>",
"roleName": "<string>",
"groupId": "<string>",
"groupName": "<string>",
"unitPreferences": {},
"sendWelcomeEmail": true,
"secondaryGroups": [
{
"id": "<string>",
"name": "<string>"
}
]
}
'import requests
url = "https://api.masternautconnect.com/connect-webservices/services/public/v1/customer/{customerId}/user/{userId}"
payload = {
"id": "<string>",
"customerId": "<string>",
"userName": "<string>",
"externalIdentifier": "<string>",
"fullName": "<string>",
"emailAddress": "<string>",
"language": {
"language": "<string>",
"script": "<string>",
"variant": "<string>",
"displayName": "<string>",
"country": "<string>",
"unicodeLocaleAttributes": ["<string>"],
"unicodeLocaleKeys": ["<string>"],
"displayLanguage": "<string>",
"displayScript": "<string>",
"displayCountry": "<string>",
"displayVariant": "<string>",
"extensionKeys": ["<string>"],
"iso3Language": "<string>",
"iso3Country": "<string>"
},
"timezone": "<string>",
"roleId": "<string>",
"roleName": "<string>",
"groupId": "<string>",
"groupName": "<string>",
"unitPreferences": {},
"sendWelcomeEmail": True,
"secondaryGroups": [
{
"id": "<string>",
"name": "<string>"
}
]
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json;charset=UTF-8"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {
Authorization: 'Basic <encoded-value>',
'Content-Type': 'application/json;charset=UTF-8'
},
body: JSON.stringify({
id: '<string>',
customerId: '<string>',
userName: '<string>',
externalIdentifier: '<string>',
fullName: '<string>',
emailAddress: '<string>',
language: {
language: '<string>',
script: '<string>',
variant: '<string>',
displayName: '<string>',
country: '<string>',
unicodeLocaleAttributes: ['<string>'],
unicodeLocaleKeys: ['<string>'],
displayLanguage: '<string>',
displayScript: '<string>',
displayCountry: '<string>',
displayVariant: '<string>',
extensionKeys: ['<string>'],
iso3Language: '<string>',
iso3Country: '<string>'
},
timezone: '<string>',
roleId: '<string>',
roleName: '<string>',
groupId: '<string>',
groupName: '<string>',
unitPreferences: {},
sendWelcomeEmail: true,
secondaryGroups: [{id: '<string>', name: '<string>'}]
})
};
fetch('https://api.masternautconnect.com/connect-webservices/services/public/v1/customer/{customerId}/user/{userId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.masternautconnect.com/connect-webservices/services/public/v1/customer/{customerId}/user/{userId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'id' => '<string>',
'customerId' => '<string>',
'userName' => '<string>',
'externalIdentifier' => '<string>',
'fullName' => '<string>',
'emailAddress' => '<string>',
'language' => [
'language' => '<string>',
'script' => '<string>',
'variant' => '<string>',
'displayName' => '<string>',
'country' => '<string>',
'unicodeLocaleAttributes' => [
'<string>'
],
'unicodeLocaleKeys' => [
'<string>'
],
'displayLanguage' => '<string>',
'displayScript' => '<string>',
'displayCountry' => '<string>',
'displayVariant' => '<string>',
'extensionKeys' => [
'<string>'
],
'iso3Language' => '<string>',
'iso3Country' => '<string>'
],
'timezone' => '<string>',
'roleId' => '<string>',
'roleName' => '<string>',
'groupId' => '<string>',
'groupName' => '<string>',
'unitPreferences' => [
],
'sendWelcomeEmail' => true,
'secondaryGroups' => [
[
'id' => '<string>',
'name' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json;charset=UTF-8"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.masternautconnect.com/connect-webservices/services/public/v1/customer/{customerId}/user/{userId}"
payload := strings.NewReader("{\n \"id\": \"<string>\",\n \"customerId\": \"<string>\",\n \"userName\": \"<string>\",\n \"externalIdentifier\": \"<string>\",\n \"fullName\": \"<string>\",\n \"emailAddress\": \"<string>\",\n \"language\": {\n \"language\": \"<string>\",\n \"script\": \"<string>\",\n \"variant\": \"<string>\",\n \"displayName\": \"<string>\",\n \"country\": \"<string>\",\n \"unicodeLocaleAttributes\": [\n \"<string>\"\n ],\n \"unicodeLocaleKeys\": [\n \"<string>\"\n ],\n \"displayLanguage\": \"<string>\",\n \"displayScript\": \"<string>\",\n \"displayCountry\": \"<string>\",\n \"displayVariant\": \"<string>\",\n \"extensionKeys\": [\n \"<string>\"\n ],\n \"iso3Language\": \"<string>\",\n \"iso3Country\": \"<string>\"\n },\n \"timezone\": \"<string>\",\n \"roleId\": \"<string>\",\n \"roleName\": \"<string>\",\n \"groupId\": \"<string>\",\n \"groupName\": \"<string>\",\n \"unitPreferences\": {},\n \"sendWelcomeEmail\": true,\n \"secondaryGroups\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json;charset=UTF-8")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.masternautconnect.com/connect-webservices/services/public/v1/customer/{customerId}/user/{userId}")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json;charset=UTF-8")
.body("{\n \"id\": \"<string>\",\n \"customerId\": \"<string>\",\n \"userName\": \"<string>\",\n \"externalIdentifier\": \"<string>\",\n \"fullName\": \"<string>\",\n \"emailAddress\": \"<string>\",\n \"language\": {\n \"language\": \"<string>\",\n \"script\": \"<string>\",\n \"variant\": \"<string>\",\n \"displayName\": \"<string>\",\n \"country\": \"<string>\",\n \"unicodeLocaleAttributes\": [\n \"<string>\"\n ],\n \"unicodeLocaleKeys\": [\n \"<string>\"\n ],\n \"displayLanguage\": \"<string>\",\n \"displayScript\": \"<string>\",\n \"displayCountry\": \"<string>\",\n \"displayVariant\": \"<string>\",\n \"extensionKeys\": [\n \"<string>\"\n ],\n \"iso3Language\": \"<string>\",\n \"iso3Country\": \"<string>\"\n },\n \"timezone\": \"<string>\",\n \"roleId\": \"<string>\",\n \"roleName\": \"<string>\",\n \"groupId\": \"<string>\",\n \"groupName\": \"<string>\",\n \"unitPreferences\": {},\n \"sendWelcomeEmail\": true,\n \"secondaryGroups\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.masternautconnect.com/connect-webservices/services/public/v1/customer/{customerId}/user/{userId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json;charset=UTF-8'
request.body = "{\n \"id\": \"<string>\",\n \"customerId\": \"<string>\",\n \"userName\": \"<string>\",\n \"externalIdentifier\": \"<string>\",\n \"fullName\": \"<string>\",\n \"emailAddress\": \"<string>\",\n \"language\": {\n \"language\": \"<string>\",\n \"script\": \"<string>\",\n \"variant\": \"<string>\",\n \"displayName\": \"<string>\",\n \"country\": \"<string>\",\n \"unicodeLocaleAttributes\": [\n \"<string>\"\n ],\n \"unicodeLocaleKeys\": [\n \"<string>\"\n ],\n \"displayLanguage\": \"<string>\",\n \"displayScript\": \"<string>\",\n \"displayCountry\": \"<string>\",\n \"displayVariant\": \"<string>\",\n \"extensionKeys\": [\n \"<string>\"\n ],\n \"iso3Language\": \"<string>\",\n \"iso3Country\": \"<string>\"\n },\n \"timezone\": \"<string>\",\n \"roleId\": \"<string>\",\n \"roleName\": \"<string>\",\n \"groupId\": \"<string>\",\n \"groupName\": \"<string>\",\n \"unitPreferences\": {},\n \"sendWelcomeEmail\": true,\n \"secondaryGroups\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_bodyAuthorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Body
application/json;charset=UTF-8
Represents a user in the system with their profile information and access settings
Unique identifier for the user
Identifier of the customer the user belongs to
Username for authentication
External identifier for SSO integration
Full display name of the user
Email address of the user
Preferred language locale
Show child attributes
Show child attributes
User's preferred timezone
Identifier of the user's role
Display name of the user's role
Identifier of the user's primary group
Display name of the user's primary group
User's unit preference settings
Show child attributes
Show child attributes
Flag indicating whether to send a welcome email
List of secondary groups the user belongs to
Show child attributes
Show child attributes
Response
User was successfully updated.
Was this page helpful?
⌘I