← User API

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

Update a specific user based on Id
headerAuthorizationAuthentication token (bearer token or API key).
{
"firstName" : com.sesamsolutions.platform.common.TriOpt[String],
"lastName" : com.sesamsolutions.platform.common.TriOpt[String],
"phoneNumber" : com.sesamsolutions.platform.common.TriOpt[com.sesamsolutions.platform.common.PhoneNumber],
"phoneNumberVerify" : Boolean,
"phoneNumberVerified" : Boolean,
"emailAddress" : com.sesamsolutions.platform.common.TriOpt[com.sesamsolutions.platform.common.EmailAddress],
"emailAddressVerify" : Boolean,
"emailAddressVerified" : Boolean,
"superUser" : Boolean,
"clientId" : com.sesamsolutions.platform.common.TriOpt[com.sesamsolutions.platform.common.Id[com.sesamsolutions.platform.devicemgmt.model.Client]],
"externalId" : com.sesamsolutions.platform.common.TriOpt[com.sesamsolutions.platform.devicemgmt.model.ExternalId],
"source" : com.sesamsolutions.platform.common.TriOpt[com.sesamsolutions.platform.devicemgmt.model.ExternalId.Source],
"description" : com.sesamsolutions.platform.common.TriOpt[String],
"remarks" : com.sesamsolutions.platform.common.TriOpt[String],
"autoRemoveAfter" : "WEEK" / "MONTH" / "YEAR",
"autoEmailMatch" : Boolean,
"requireEmailMatch" : Boolean,
"authOrganizationId" : com.sesamsolutions.platform.common.TriOpt[String],
"emailMatchCredentialFilter" : Boolean
}

Response

status200All ok, returned ID of updated user
status400Invalid roles
status401Invalid authentication token
status403Insufficient rights
status404User not found
Number

Example: Update a user for specified Id

PUT/v2/users/4

headerAuthorizationBearer 49ae0a1c-0fbb-477a-a604-996524562238
{
"firstName": "Caroline",
"phoneNumberVerify": null,
"phoneNumberVerified": null,
"emailAddressVerify": null,
"emailAddressVerified": null,
"superUser": null,
"autoRemoveAfter": null,
"autoEmailMatch": null,
"requireEmailMatch": null,
"emailMatchCredentialFilter": null
}

Response

status200
headerAccess-Control-Expose-Headersauthorization, content-type
headerAccess-Control-Allow-Headersauthorization, content-type
headerAccess-Control-Allow-MethodsGET, POST, DELETE, OPTIONS, PUT
headerAccess-Control-Allow-Origin*
headerStrict-Transport-Securitymax-age=31536000; includeSubDomains
headerX-Frame-OptionsSAMEORIGIN
headerX-Content-Type-Optionsnosniff
headerX-XSS-Protection1; mode=block
headerContent-Security-Policydefault-src 'none'; frame-ancestors 'none'; base-uri 'none'; form-action 'none'
headerReferrer-Policyno-referrer
headerFeature-Policyself
headerPermissions-policyinterest-cohort=()
4

Example: Update a user for a personal organization

PUT/v2/users/1

headerAuthorizationBearer 49ae0a1c-0fbb-477a-a604-996524562238
{
"firstName": "Andrew",
"phoneNumberVerify": null,
"phoneNumberVerified": null,
"emailAddressVerify": null,
"emailAddressVerified": null,
"superUser": null,
"autoRemoveAfter": null,
"autoEmailMatch": null,
"requireEmailMatch": null,
"emailMatchCredentialFilter": null
}

Response

status200
headerAccess-Control-Expose-Headersauthorization, content-type
headerAccess-Control-Allow-Headersauthorization, content-type
headerAccess-Control-Allow-MethodsGET, POST, DELETE, OPTIONS, PUT
headerAccess-Control-Allow-Origin*
headerStrict-Transport-Securitymax-age=31536000; includeSubDomains
headerX-Frame-OptionsSAMEORIGIN
headerX-Content-Type-Optionsnosniff
headerX-XSS-Protection1; mode=block
headerContent-Security-Policydefault-src 'none'; frame-ancestors 'none'; base-uri 'none'; form-action 'none'
headerReferrer-Policyno-referrer
headerFeature-Policyself
headerPermissions-policyinterest-cohort=()
1

Example: Treat the update as authoritative for the external-id source

Example: Clear the source of a source-only user via null

Example: Reject clearing the source while the user keeps an external id

Example: Clear the external id via null, keeping a source-only row