Update user
curl --request PUT \
--url http://10.2.4.166:8080/composer/api/users/{id} \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/vnd.composer.v3+json' \
--data '
{
"userOrigin": "<string>",
"localeSettingsId": "<string>",
"id": "<string>",
"fullname": "<string>",
"email": "<string>",
"accountId": "<string>",
"accounts": [
{
"id": "<string>",
"userId": "<string>",
"accountId": "<string>",
"groups": [
"<string>"
],
"roles": [
"<string>"
],
"userAttributes": [
{
"key": "<string>",
"value": "<string>",
"encrypted": true
}
],
"disabled": true,
"replyToAddress": "<string>",
"senderDisplayName": "<string>",
"accountName": "<string>",
"accountDisabled": true
}
],
"name": "<string>",
"password": "<string>",
"groupRoles": [
"<string>"
],
"forcePasswordChange": true,
"showQuickstart": true,
"external": true,
"ldapDn": "<string>",
"languageLocaleId": "<string>",
"timeZone": "<string>",
"version": 123
}
'import requests
url = "http://10.2.4.166:8080/composer/api/users/{id}"
payload = {
"userOrigin": "<string>",
"localeSettingsId": "<string>",
"id": "<string>",
"fullname": "<string>",
"email": "<string>",
"accountId": "<string>",
"accounts": [
{
"id": "<string>",
"userId": "<string>",
"accountId": "<string>",
"groups": ["<string>"],
"roles": ["<string>"],
"userAttributes": [
{
"key": "<string>",
"value": "<string>",
"encrypted": True
}
],
"disabled": True,
"replyToAddress": "<string>",
"senderDisplayName": "<string>",
"accountName": "<string>",
"accountDisabled": True
}
],
"name": "<string>",
"password": "<string>",
"groupRoles": ["<string>"],
"forcePasswordChange": True,
"showQuickstart": True,
"external": True,
"ldapDn": "<string>",
"languageLocaleId": "<string>",
"timeZone": "<string>",
"version": 123
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/vnd.composer.v3+json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {
Authorization: 'Basic <encoded-value>',
'Content-Type': 'application/vnd.composer.v3+json'
},
body: JSON.stringify({
userOrigin: '<string>',
localeSettingsId: '<string>',
id: '<string>',
fullname: '<string>',
email: '<string>',
accountId: '<string>',
accounts: [
{
id: '<string>',
userId: '<string>',
accountId: '<string>',
groups: ['<string>'],
roles: ['<string>'],
userAttributes: [{key: '<string>', value: '<string>', encrypted: true}],
disabled: true,
replyToAddress: '<string>',
senderDisplayName: '<string>',
accountName: '<string>',
accountDisabled: true
}
],
name: '<string>',
password: '<string>',
groupRoles: ['<string>'],
forcePasswordChange: true,
showQuickstart: true,
external: true,
ldapDn: '<string>',
languageLocaleId: '<string>',
timeZone: '<string>',
version: 123
})
};
fetch('http://10.2.4.166:8080/composer/api/users/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8080",
CURLOPT_URL => "http://10.2.4.166:8080/composer/api/users/{id}",
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([
'userOrigin' => '<string>',
'localeSettingsId' => '<string>',
'id' => '<string>',
'fullname' => '<string>',
'email' => '<string>',
'accountId' => '<string>',
'accounts' => [
[
'id' => '<string>',
'userId' => '<string>',
'accountId' => '<string>',
'groups' => [
'<string>'
],
'roles' => [
'<string>'
],
'userAttributes' => [
[
'key' => '<string>',
'value' => '<string>',
'encrypted' => true
]
],
'disabled' => true,
'replyToAddress' => '<string>',
'senderDisplayName' => '<string>',
'accountName' => '<string>',
'accountDisabled' => true
]
],
'name' => '<string>',
'password' => '<string>',
'groupRoles' => [
'<string>'
],
'forcePasswordChange' => true,
'showQuickstart' => true,
'external' => true,
'ldapDn' => '<string>',
'languageLocaleId' => '<string>',
'timeZone' => '<string>',
'version' => 123
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/vnd.composer.v3+json"
],
]);
$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 := "http://10.2.4.166:8080/composer/api/users/{id}"
payload := strings.NewReader("{\n \"userOrigin\": \"<string>\",\n \"localeSettingsId\": \"<string>\",\n \"id\": \"<string>\",\n \"fullname\": \"<string>\",\n \"email\": \"<string>\",\n \"accountId\": \"<string>\",\n \"accounts\": [\n {\n \"id\": \"<string>\",\n \"userId\": \"<string>\",\n \"accountId\": \"<string>\",\n \"groups\": [\n \"<string>\"\n ],\n \"roles\": [\n \"<string>\"\n ],\n \"userAttributes\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\",\n \"encrypted\": true\n }\n ],\n \"disabled\": true,\n \"replyToAddress\": \"<string>\",\n \"senderDisplayName\": \"<string>\",\n \"accountName\": \"<string>\",\n \"accountDisabled\": true\n }\n ],\n \"name\": \"<string>\",\n \"password\": \"<string>\",\n \"groupRoles\": [\n \"<string>\"\n ],\n \"forcePasswordChange\": true,\n \"showQuickstart\": true,\n \"external\": true,\n \"ldapDn\": \"<string>\",\n \"languageLocaleId\": \"<string>\",\n \"timeZone\": \"<string>\",\n \"version\": 123\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/vnd.composer.v3+json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("http://10.2.4.166:8080/composer/api/users/{id}")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/vnd.composer.v3+json")
.body("{\n \"userOrigin\": \"<string>\",\n \"localeSettingsId\": \"<string>\",\n \"id\": \"<string>\",\n \"fullname\": \"<string>\",\n \"email\": \"<string>\",\n \"accountId\": \"<string>\",\n \"accounts\": [\n {\n \"id\": \"<string>\",\n \"userId\": \"<string>\",\n \"accountId\": \"<string>\",\n \"groups\": [\n \"<string>\"\n ],\n \"roles\": [\n \"<string>\"\n ],\n \"userAttributes\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\",\n \"encrypted\": true\n }\n ],\n \"disabled\": true,\n \"replyToAddress\": \"<string>\",\n \"senderDisplayName\": \"<string>\",\n \"accountName\": \"<string>\",\n \"accountDisabled\": true\n }\n ],\n \"name\": \"<string>\",\n \"password\": \"<string>\",\n \"groupRoles\": [\n \"<string>\"\n ],\n \"forcePasswordChange\": true,\n \"showQuickstart\": true,\n \"external\": true,\n \"ldapDn\": \"<string>\",\n \"languageLocaleId\": \"<string>\",\n \"timeZone\": \"<string>\",\n \"version\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://10.2.4.166:8080/composer/api/users/{id}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/vnd.composer.v3+json'
request.body = "{\n \"userOrigin\": \"<string>\",\n \"localeSettingsId\": \"<string>\",\n \"id\": \"<string>\",\n \"fullname\": \"<string>\",\n \"email\": \"<string>\",\n \"accountId\": \"<string>\",\n \"accounts\": [\n {\n \"id\": \"<string>\",\n \"userId\": \"<string>\",\n \"accountId\": \"<string>\",\n \"groups\": [\n \"<string>\"\n ],\n \"roles\": [\n \"<string>\"\n ],\n \"userAttributes\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\",\n \"encrypted\": true\n }\n ],\n \"disabled\": true,\n \"replyToAddress\": \"<string>\",\n \"senderDisplayName\": \"<string>\",\n \"accountName\": \"<string>\",\n \"accountDisabled\": true\n }\n ],\n \"name\": \"<string>\",\n \"password\": \"<string>\",\n \"groupRoles\": [\n \"<string>\"\n ],\n \"forcePasswordChange\": true,\n \"showQuickstart\": true,\n \"external\": true,\n \"ldapDn\": \"<string>\",\n \"languageLocaleId\": \"<string>\",\n \"timeZone\": \"<string>\",\n \"version\": 123\n}"
response = http.request(request)
puts response.read_body{
"userOrigin": "<string>",
"localeSettingsId": "<string>",
"createdByUserID": "<string>",
"lastModifiedByUserID": "<string>",
"createdDate": "2023-11-07T05:31:56Z",
"lastModifiedDate": "2023-11-07T05:31:56Z",
"id": "<string>",
"fullname": "<string>",
"email": "<string>",
"accountId": "<string>",
"accounts": [
{
"id": "<string>",
"userId": "<string>",
"accountId": "<string>",
"groups": [
"<string>"
],
"roles": [
"<string>"
],
"userAttributes": [
{
"key": "<string>",
"value": "<string>",
"encrypted": true
}
],
"disabled": true,
"replyToAddress": "<string>",
"senderDisplayName": "<string>",
"accountName": "<string>",
"accountDisabled": true
}
],
"name": "<string>",
"password": "<string>",
"groupRoles": [
"<string>"
],
"forcePasswordChange": true,
"showQuickstart": true,
"external": true,
"ldapDn": "<string>",
"languageLocaleId": "<string>",
"timeZone": "<string>",
"deletable": true,
"availableAttributeKeys": [
"<string>"
],
"activeGroups": [
"<string>"
],
"activeRoles": [
"<string>"
],
"version": 123,
"userId": "<string>"
}Update user
Supervisor authority or role Administer Users is required to access this endpoint
Update user
curl --request PUT \
--url http://10.2.4.166:8080/composer/api/users/{id} \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/vnd.composer.v3+json' \
--data '
{
"userOrigin": "<string>",
"localeSettingsId": "<string>",
"id": "<string>",
"fullname": "<string>",
"email": "<string>",
"accountId": "<string>",
"accounts": [
{
"id": "<string>",
"userId": "<string>",
"accountId": "<string>",
"groups": [
"<string>"
],
"roles": [
"<string>"
],
"userAttributes": [
{
"key": "<string>",
"value": "<string>",
"encrypted": true
}
],
"disabled": true,
"replyToAddress": "<string>",
"senderDisplayName": "<string>",
"accountName": "<string>",
"accountDisabled": true
}
],
"name": "<string>",
"password": "<string>",
"groupRoles": [
"<string>"
],
"forcePasswordChange": true,
"showQuickstart": true,
"external": true,
"ldapDn": "<string>",
"languageLocaleId": "<string>",
"timeZone": "<string>",
"version": 123
}
'import requests
url = "http://10.2.4.166:8080/composer/api/users/{id}"
payload = {
"userOrigin": "<string>",
"localeSettingsId": "<string>",
"id": "<string>",
"fullname": "<string>",
"email": "<string>",
"accountId": "<string>",
"accounts": [
{
"id": "<string>",
"userId": "<string>",
"accountId": "<string>",
"groups": ["<string>"],
"roles": ["<string>"],
"userAttributes": [
{
"key": "<string>",
"value": "<string>",
"encrypted": True
}
],
"disabled": True,
"replyToAddress": "<string>",
"senderDisplayName": "<string>",
"accountName": "<string>",
"accountDisabled": True
}
],
"name": "<string>",
"password": "<string>",
"groupRoles": ["<string>"],
"forcePasswordChange": True,
"showQuickstart": True,
"external": True,
"ldapDn": "<string>",
"languageLocaleId": "<string>",
"timeZone": "<string>",
"version": 123
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/vnd.composer.v3+json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {
Authorization: 'Basic <encoded-value>',
'Content-Type': 'application/vnd.composer.v3+json'
},
body: JSON.stringify({
userOrigin: '<string>',
localeSettingsId: '<string>',
id: '<string>',
fullname: '<string>',
email: '<string>',
accountId: '<string>',
accounts: [
{
id: '<string>',
userId: '<string>',
accountId: '<string>',
groups: ['<string>'],
roles: ['<string>'],
userAttributes: [{key: '<string>', value: '<string>', encrypted: true}],
disabled: true,
replyToAddress: '<string>',
senderDisplayName: '<string>',
accountName: '<string>',
accountDisabled: true
}
],
name: '<string>',
password: '<string>',
groupRoles: ['<string>'],
forcePasswordChange: true,
showQuickstart: true,
external: true,
ldapDn: '<string>',
languageLocaleId: '<string>',
timeZone: '<string>',
version: 123
})
};
fetch('http://10.2.4.166:8080/composer/api/users/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8080",
CURLOPT_URL => "http://10.2.4.166:8080/composer/api/users/{id}",
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([
'userOrigin' => '<string>',
'localeSettingsId' => '<string>',
'id' => '<string>',
'fullname' => '<string>',
'email' => '<string>',
'accountId' => '<string>',
'accounts' => [
[
'id' => '<string>',
'userId' => '<string>',
'accountId' => '<string>',
'groups' => [
'<string>'
],
'roles' => [
'<string>'
],
'userAttributes' => [
[
'key' => '<string>',
'value' => '<string>',
'encrypted' => true
]
],
'disabled' => true,
'replyToAddress' => '<string>',
'senderDisplayName' => '<string>',
'accountName' => '<string>',
'accountDisabled' => true
]
],
'name' => '<string>',
'password' => '<string>',
'groupRoles' => [
'<string>'
],
'forcePasswordChange' => true,
'showQuickstart' => true,
'external' => true,
'ldapDn' => '<string>',
'languageLocaleId' => '<string>',
'timeZone' => '<string>',
'version' => 123
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/vnd.composer.v3+json"
],
]);
$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 := "http://10.2.4.166:8080/composer/api/users/{id}"
payload := strings.NewReader("{\n \"userOrigin\": \"<string>\",\n \"localeSettingsId\": \"<string>\",\n \"id\": \"<string>\",\n \"fullname\": \"<string>\",\n \"email\": \"<string>\",\n \"accountId\": \"<string>\",\n \"accounts\": [\n {\n \"id\": \"<string>\",\n \"userId\": \"<string>\",\n \"accountId\": \"<string>\",\n \"groups\": [\n \"<string>\"\n ],\n \"roles\": [\n \"<string>\"\n ],\n \"userAttributes\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\",\n \"encrypted\": true\n }\n ],\n \"disabled\": true,\n \"replyToAddress\": \"<string>\",\n \"senderDisplayName\": \"<string>\",\n \"accountName\": \"<string>\",\n \"accountDisabled\": true\n }\n ],\n \"name\": \"<string>\",\n \"password\": \"<string>\",\n \"groupRoles\": [\n \"<string>\"\n ],\n \"forcePasswordChange\": true,\n \"showQuickstart\": true,\n \"external\": true,\n \"ldapDn\": \"<string>\",\n \"languageLocaleId\": \"<string>\",\n \"timeZone\": \"<string>\",\n \"version\": 123\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/vnd.composer.v3+json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("http://10.2.4.166:8080/composer/api/users/{id}")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/vnd.composer.v3+json")
.body("{\n \"userOrigin\": \"<string>\",\n \"localeSettingsId\": \"<string>\",\n \"id\": \"<string>\",\n \"fullname\": \"<string>\",\n \"email\": \"<string>\",\n \"accountId\": \"<string>\",\n \"accounts\": [\n {\n \"id\": \"<string>\",\n \"userId\": \"<string>\",\n \"accountId\": \"<string>\",\n \"groups\": [\n \"<string>\"\n ],\n \"roles\": [\n \"<string>\"\n ],\n \"userAttributes\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\",\n \"encrypted\": true\n }\n ],\n \"disabled\": true,\n \"replyToAddress\": \"<string>\",\n \"senderDisplayName\": \"<string>\",\n \"accountName\": \"<string>\",\n \"accountDisabled\": true\n }\n ],\n \"name\": \"<string>\",\n \"password\": \"<string>\",\n \"groupRoles\": [\n \"<string>\"\n ],\n \"forcePasswordChange\": true,\n \"showQuickstart\": true,\n \"external\": true,\n \"ldapDn\": \"<string>\",\n \"languageLocaleId\": \"<string>\",\n \"timeZone\": \"<string>\",\n \"version\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://10.2.4.166:8080/composer/api/users/{id}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/vnd.composer.v3+json'
request.body = "{\n \"userOrigin\": \"<string>\",\n \"localeSettingsId\": \"<string>\",\n \"id\": \"<string>\",\n \"fullname\": \"<string>\",\n \"email\": \"<string>\",\n \"accountId\": \"<string>\",\n \"accounts\": [\n {\n \"id\": \"<string>\",\n \"userId\": \"<string>\",\n \"accountId\": \"<string>\",\n \"groups\": [\n \"<string>\"\n ],\n \"roles\": [\n \"<string>\"\n ],\n \"userAttributes\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\",\n \"encrypted\": true\n }\n ],\n \"disabled\": true,\n \"replyToAddress\": \"<string>\",\n \"senderDisplayName\": \"<string>\",\n \"accountName\": \"<string>\",\n \"accountDisabled\": true\n }\n ],\n \"name\": \"<string>\",\n \"password\": \"<string>\",\n \"groupRoles\": [\n \"<string>\"\n ],\n \"forcePasswordChange\": true,\n \"showQuickstart\": true,\n \"external\": true,\n \"ldapDn\": \"<string>\",\n \"languageLocaleId\": \"<string>\",\n \"timeZone\": \"<string>\",\n \"version\": 123\n}"
response = http.request(request)
puts response.read_body{
"userOrigin": "<string>",
"localeSettingsId": "<string>",
"createdByUserID": "<string>",
"lastModifiedByUserID": "<string>",
"createdDate": "2023-11-07T05:31:56Z",
"lastModifiedDate": "2023-11-07T05:31:56Z",
"id": "<string>",
"fullname": "<string>",
"email": "<string>",
"accountId": "<string>",
"accounts": [
{
"id": "<string>",
"userId": "<string>",
"accountId": "<string>",
"groups": [
"<string>"
],
"roles": [
"<string>"
],
"userAttributes": [
{
"key": "<string>",
"value": "<string>",
"encrypted": true
}
],
"disabled": true,
"replyToAddress": "<string>",
"senderDisplayName": "<string>",
"accountName": "<string>",
"accountDisabled": true
}
],
"name": "<string>",
"password": "<string>",
"groupRoles": [
"<string>"
],
"forcePasswordChange": true,
"showQuickstart": true,
"external": true,
"ldapDn": "<string>",
"languageLocaleId": "<string>",
"timeZone": "<string>",
"deletable": true,
"availableAttributeKeys": [
"<string>"
],
"activeGroups": [
"<string>"
],
"activeRoles": [
"<string>"
],
"version": 123,
"userId": "<string>"
}Authorizations
HTTP Basic authentication using global administrator credentials (username and password).
Path Parameters
Body
application/vnd.composer.v3+json
User object contains information on application users
Show child attributes
Show child attributes
(deprecated since 7.10, to be removed in 8.x)
(deprecated since 7.10, to be removed in 8.x)
(deprecated since 7.10, to be removed in 8.x)
Response
200 - application/vnd.composer.v3+json
OK
User object contains information on application users
Show child attributes
Show child attributes
(deprecated since 7.10, to be removed in 8.x)
(deprecated since 7.10, to be removed in 8.x)
(deprecated since 7.10, to be removed in 8.x)
(deprecated since 7.10, to be removed in 8.x)
(deprecated since 7.10, to be removed in 8.x) Use the 'id' field instead
Was this page helpful?