{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/users/:userId","auth":"required","try":false,"basic_auth":false,"method":"put","params":[{"name":"userName","type":"string","default":"","desc":"Optional. Must be unique. May only contain letters, numbers, periods, dashes, underscores and :::at::: symbols. Must not be empty if included in request.","required":false,"in":"body","ref":"","_id":"54ac46fbec3be11400c8b011"},{"name":"password","type":"string","default":"","desc":"Optional. Must be at least 8 characters and contain at least one number, one upper case letter, one lower case letter and one special character: [email protected]#$%^&*,. For security, your password cannot contain your username. Must not be empty if included in request.","required":false,"in":"body","ref":"","_id":"54ac46fbec3be11400c8b010"},{"name":"firstName","type":"string","default":"","desc":"First name, sending empty data will delete this field.","required":false,"in":"body","ref":"","_id":"54ac46fbec3be11400c8b00f"},{"name":"lastName","type":"string","default":"","desc":"Last name, sending empty data will delete this field.","required":false,"in":"body","ref":"","_id":"54ac46fbec3be11400c8b00e"},{"name":"company","type":"string","default":"","desc":"Company name","required":false,"in":"body","ref":"","_id":"54ac46fbec3be11400c8b00d"},{"name":"email","type":"string","default":"","desc":"Email. Must not be empty if included in request.","required":false,"in":"body","ref":"","_id":"54ac46fbec3be11400c8b00c"},{"name":"phone","type":"string","default":"","desc":"Phone number","required":false,"in":"body","ref":"","_id":"54ac46fbec3be11400c8b00b"},{"name":"mobile","type":"string","default":"","desc":"Phone Number","required":false,"in":"body","ref":"","_id":"54ac46fbec3be11400c8b00a"},{"name":"address","type":"object","default":"Object Hash","desc":"Address (object hash)","required":false,"in":"body","ref":"","_id":"54ac46fbec3be11400c8b009"},{"name":"status","type":"string","default":"ACTIVE, LOCKED, DELETED","desc":"Optional. Possible values are: ACTIVE, LOCKED and DELETED.","required":false,"in":"body","ref":"","_id":"54ac46fbec3be11400c8b008"},{"name":"sso","type":"boolean","default":"","desc":"Used in conjunction with the sso field to store the SSO identifier for the user. Must be set.","required":false,"in":"body","ref":"","_id":"54ac46fbec3be11400c8b007"},{"name":"ssoId","type":"string","default":"","desc":"Used in conjunction with the sso field to store the SSO identifier for the user.","required":false,"in":"body","ref":"","_id":"54ac46fbec3be11400c8b006"},{"name":"defaultRoleTemplateId","type":"string","default":"","desc":"ID of the default Role Template to use when user is added to a Project","required":false,"in":"body","ref":"","_id":"54ac46fbec3be11400c8b005"},{"name":"userId","type":"string","default":"","desc":"User id","required":true,"in":"path","ref":"","_id":"54ac490fde18cc1400226e91"}],"results":{"codes":[]}},"next":{"description":"","pages":[]},"title":"Update User","type":"endpoint","slug":"update-current-user","excerpt":"Updates the the user specified in id","body":"Updates the the current user.\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Partial Data\",\n  \"body\": \"The above example may not work if certain fields are left blank. Check the parameter description.\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"put\",\n  \"title\": \"Update Specific User\"\n}\n[/block]\nUpdates a specific user, provided the request is made by a user with an account-level role of ADMINISTRATOR.","updates":["54c66795f2ab9319008e813a"],"order":6,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"54883047f291f61400c02be5","createdAt":"2014-12-10T11:36:39.329Z","version":{"version":"3.0","version_clean":"3.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["54343531bfaa3d0800c4d4b0","543435b1edce040800409240","543435b9edce040800409241","543435bcedce040800409243","543435bfedce040800409244","543435c2edce040800409245","54370cc426469424002a6dfa","54370cf026469424002a6dfd","5437129d26469424002a6e2f","543712d226469424002a6e30","5480c8fd74904f1a00053c86","54aafc6eefb39016009e4d71","54ac1d36de18cc1400226e01","54ad59369219922100751732","54b41bcf4f25cb1600518d2c","54b533a3a806f40c0050d53c","54b54bbf96fe3c0b00d38d2a","54b688a27379a90c00f53a8a","54b699efbc1a46160005edfa","54b8191691011f0b00068804","54bfb002d03bfc0d0000e814","54bfb33ed03bfc0d0000e816","55a3e94e912a6e2300882cdb","55a56c370f354f0d00fd02a8","55e85ad034516037002e9325","5638ecb62fc5520d001a4cf9","572cba2fc310640e008f63d5","596e6e42c5b53b00509791b1"],"_id":"54343531bfaa3d0800c4d4af","project":"54343170fa5527080064f449","releaseDate":"2014-10-07T18:47:13.086Z","__v":28,"createdAt":"2014-10-07T18:47:13.086Z","forked_from":"54343170fa5527080064f44c"},"__v":5,"editedParams2":true,"githubsync":"","parentDoc":null,"project":"54343170fa5527080064f449","category":{"sync":{"isSync":false,"url":""},"pages":["5437151b26469424002a6e38","5437134326469424002a6e31","5488258fc178b40b00aa2ef8","54882d35c178b40b00aa2f0e","54883047f291f61400c02be5","54ac00aeec3be11400c8af68","54ac01e8ec3be11400c8af6a","54ac2205ec3be11400c8afad"],"title":"Users","slug":"users","order":5,"from_sync":false,"reference":false,"_id":"543712d226469424002a6e30","__v":8,"createdAt":"2014-10-09T22:57:22.917Z","project":"54343170fa5527080064f449","version":"54343531bfaa3d0800c4d4af"},"editedParams":true,"user":"54343147fa5527080064f43f"}

putUpdate User

Updates the the user specified in id

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

userId:
required
string
User id

Body Params

userName:
string
Optional. Must be unique. May only contain letters, numbers, periods, dashes, underscores and @ symbols. Must not be empty if included in request.
password:
string
Optional. Must be at least 8 characters and contain at least one number, one upper case letter, one lower case letter and one special character: [email protected]#$%^&*,. For security, your password cannot contain your username. Must not be empty if included in request.
firstName:
string
First name, sending empty data will delete this field.
lastName:
string
Last name, sending empty data will delete this field.
company:
string
Company name
email:
string
Email. Must not be empty if included in request.
phone:
string
Phone number
mobile:
string
Phone Number
address:
objectObject Hash
Address (object hash)
status:
stringACTIVE, LOCKED, DELETED
Optional. Possible values are: ACTIVE, LOCKED and DELETED.
sso:
boolean
Used in conjunction with the sso field to store the SSO identifier for the user. Must be set.
ssoId:
string
Used in conjunction with the sso field to store the SSO identifier for the user.
defaultRoleTemplateId:
string
ID of the default Role Template to use when user is added to a Project

Documentation

Updates the the current user. [block:callout] { "type": "warning", "title": "Partial Data", "body": "The above example may not work if certain fields are left blank. Check the parameter description." } [/block] [block:api-header] { "type": "put", "title": "Update Specific User" } [/block] Updates a specific user, provided the request is made by a user with an account-level role of ADMINISTRATOR.

User Information

Try It Out

put
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}