PUT/v2/users/{user-Id}Update user

Update a specific user based on Id

parameter	groupAdmin	Make the user a group admin: Boolean
parameter	userGroupId	Used together with the group admin parameter: Number
header	Authorization	Authentication token (bearer token or API key).
{ "firstName" : String, "lastName" : String, "phoneNumber" : Phone number (E.164, e.g. "+31850607337"), "phoneNumberVerify" : Boolean, "emailAddress" : String, "emailAddressVerify" : Boolean, "superUser" : Boolean, "clientId" : Number, "externalId" : String, "description" : String, "remarks" : String, "autoRemoveAfter" : "WEEK" / "MONTH" / "YEAR", "autoEmailMatch" : Boolean, "requireEmailMatch" : Boolean, "authOrganizationId" : String, "emailMatchCredentialFilter" : Boolean }

Response

status	200	All ok, returned ID of updated user
status	400	Invalid roles
status	401	Invalid authentication token
status	403	Insufficient rights
status	404	User not found
Number

Example: Update a user for specified Id

PUT/v2/users/4

header	Authorization	Bearer fdcd8cc5-d18e-4a65-80a4-291ee55ef77a
{ "firstName": "Caroline" }

Response

status	200
header	Access-Control-Expose-Headers	authorization, content-type
header	Access-Control-Allow-Headers	authorization, content-type
header	Access-Control-Allow-Methods	GET, POST, DELETE, OPTIONS, PUT
header	Access-Control-Allow-Origin	*
header	Strict-Transport-Security	max-age=31536000; includeSubDomains
header	X-Frame-Options	SAMEORIGIN
header	X-Content-Type-Options	nosniff
header	X-XSS-Protection	1; mode=block
header	Content-Security-Policy	default-src 'none'; frame-ancestors 'none'; base-uri 'none'; form-action 'none'
header	Referrer-Policy	no-referrer
header	Feature-Policy	self
header	Permissions-policy	interest-cohort=()
4

Example: Update a user for a personal organization

PUT/v2/users/1

header	Authorization	Bearer 93c8b2ae-301b-47fe-842f-afe9b98b427a
{ "firstName": "Andrew" }

Response

status	200
header	Access-Control-Expose-Headers	authorization, content-type
header	Access-Control-Allow-Headers	authorization, content-type
header	Access-Control-Allow-Methods	GET, POST, DELETE, OPTIONS, PUT
header	Access-Control-Allow-Origin	*
header	Strict-Transport-Security	max-age=31536000; includeSubDomains
header	X-Frame-Options	SAMEORIGIN
header	X-Content-Type-Options	nosniff
header	X-XSS-Protection	1; mode=block
header	Content-Security-Policy	default-src 'none'; frame-ancestors 'none'; base-uri 'none'; form-action 'none'
header	Referrer-Policy	no-referrer
header	Feature-Policy	self
header	Permissions-policy	interest-cohort=()
1

Example: Make a user an group administrator in the specified user group

PUT/v2/users/7

parameter	userGroupId	1
parameter	groupAdmin	true
header	Authorization	Bearer 318218ff-0308-407b-b847-4a126fa23da7
{}

Response

status	200
header	Access-Control-Expose-Headers	authorization, content-type
header	Access-Control-Allow-Headers	authorization, content-type
header	Access-Control-Allow-Methods	GET, POST, DELETE, OPTIONS, PUT
header	Access-Control-Allow-Origin	*
header	Strict-Transport-Security	max-age=31536000; includeSubDomains
header	X-Frame-Options	SAMEORIGIN
header	X-Content-Type-Options	nosniff
header	X-XSS-Protection	1; mode=block
header	Content-Security-Policy	default-src 'none'; frame-ancestors 'none'; base-uri 'none'; form-action 'none'
header	Referrer-Policy	no-referrer
header	Feature-Policy	self
header	Permissions-policy	interest-cohort=()
7