{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/users/?notify=:notify","auth":"required","results":{"codes":[{"status":200,"language":"json","code":"// Returns a user id\n{\n\t\"id\": \"c0908276-9487-49d8-af06-b42157b92dab\"\n}","name":""},{"status":400,"language":"json","code":"// Failed requests indicates which fields are missing\n{\n\t\"email\": \"The email address: null is not valid.\",\n\t\"userName\": \"The username apitester123 is already being used.\"\n}","name":""}]},"settings":"","try":false,"basic_auth":false,"method":"post","params":[{"name":"userName","type":"string","default":"","desc":"Optional. Must be unique. May only contain letters, numbers, periods, dashes, underscores and :::at::: symbols.","required":true,"in":"body","ref":"","_id":"54ac5fc2ec3be11400c8b054"},{"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.","required":true,"in":"body","ref":"","_id":"54ac5fc2ec3be11400c8b053"},{"name":"firstName","type":"string","default":"","desc":"","required":true,"in":"body","ref":"","_id":"54ac5fc2ec3be11400c8b052"},{"name":"lastName","type":"string","default":"","desc":"","required":true,"in":"body","ref":"","_id":"54ac5fc2ec3be11400c8b051"},{"name":"company","type":"string","default":"","desc":"","required":false,"in":"body","ref":"","_id":"54ac5fc2ec3be11400c8b050"},{"name":"email","type":"string","default":"","desc":"","required":false,"in":"body","ref":"","_id":"54ac5fc2ec3be11400c8b04f"},{"name":"phone","type":"string","default":"","desc":"","required":false,"in":"body","ref":"","_id":"54ac5fc2ec3be11400c8b04e"},{"name":"mobile","type":"string","default":"","desc":"","required":false,"in":"body","ref":"","_id":"54ac5fc2ec3be11400c8b04d"},{"name":"address","type":"object","default":"","desc":"Address object","required":false,"in":"body","ref":"","_id":"54ac5fc2ec3be11400c8b04c"},{"name":"sso","type":"string","default":"","desc":"Optional. Set to true if user should log in via Single Sign-On (SSO).","required":false,"in":"body","ref":"","_id":"54ac5fc2ec3be11400c8b04b"},{"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":"54ac5fc2ec3be11400c8b04a"},{"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":"54ac5fc2ec3be11400c8b049"},{"name":"tags","type":"string","default":"Boston,Producer","desc":"Comma separated list of tags","required":false,"in":"body","ref":"","_id":"54ad5566f6f5b10b0066dcb2"},{"name":"notify","type":"boolean","default":"true","desc":"True to send user an email containing their username and login link","required":false,"in":"path","ref":"","_id":"563267b4c3b04b0d00ba9cbc"}]},"next":{"description":"","pages":[]},"title":"Create User","type":"endpoint","slug":"create-user","excerpt":"Creates a new user","body":"Users are at the core of all MediaSilo applications. In addition to containing a user's name, address and contact information, the User object contains an array of Roles that enable a user to perform certain tasks within the scope of an Account or Project, and an array of Tags that can be used to group, sort and filter user lists.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Users must be assigned to projects to access assets\",\n  \"body\": \"All assets are organized into projects, and a user must be assigned to a project to work with the assets within it. Once your user has been created, you will need to [assign them to a project](http://docs.mediasilo.com/v3.0/docs/add-user-to-project) in order for the user to access MediaSilo functionality.\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"// Sample payload for creating a user\\n{\\n    \\\"userName\\\": \\\"johndoe\\\",\\n    \\\"password\\\": \\\"[email protected]@ssw0rd!\\\",\\n    \\\"firstName\\\": \\\"John\\\",\\n    \\\"lastName\\\": \\\"Doe\\\",\\n    \\\"company\\\": \\\"MediaSilo\\\",\\n    \\\"email\\\": \\\"[email protected]\\\",\\n    \\\"phone\\\": \\\"555 444 3333\\\",\\n    \\\"mobile\\\": \\\"555 222 1111\\\",\\n    \\\"address\\\": {\\n        \\\"address1\\\": \\\"123 Main Street\\\",\\n        \\\"address2\\\": \\\"Suite 456\\\",\\n        \\\"city\\\": \\\"Boston\\\",\\n        \\\"province\\\": \\\"MA\\\",\\n        \\\"postalCode\\\": \\\"02111\\\",\\n        \\\"country\\\": \\\"United States\\\"\\n    },\\n    \\\"sso\\\": true,\\n    \\\"ssoId\\\": \\\"mySsoId\\\",\\n    \\\"defaultRoleTemplateId\\\": \\\"448aeb72-4a5d-4b76-b3bb-fa5935f47244\\\"\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Attributes\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Attributes\",\n    \"h-1\": \"Types\",\n    \"h-2\": \"Comments\",\n    \"0-0\": \"userName\",\n    \"0-1\": \"string\",\n    \"0-2\": \"Optional. Must be unique. May only contain letters, numbers, periods, dashes, underscores and @ symbols.\",\n    \"1-0\": \"password\",\n    \"1-1\": \"string\",\n    \"1-2\": \"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]#$%^&amp;*,. For security, your password cannot contain your username.\",\n    \"2-0\": \"firstName\",\n    \"2-1\": \"string\",\n    \"2-2\": \"Optional\",\n    \"3-0\": \"lastName\",\n    \"3-1\": \"string\",\n    \"3-2\": \"Optional\",\n    \"4-0\": \"company\",\n    \"4-1\": \"string\",\n    \"4-2\": \"Optional\",\n    \"5-0\": \"email\",\n    \"5-1\": \"string\",\n    \"5-2\": \"Required\",\n    \"6-0\": \"mobile\",\n    \"6-1\": \"string\",\n    \"6-2\": \"Optional\",\n    \"7-0\": \"address\",\n    \"7-1\": \"string\",\n    \"7-2\": \"Optional. See below for description of address object.\",\n    \"8-0\": \"sso\",\n    \"8-1\": \"boolean\",\n    \"8-2\": \"Optional. Set to true if user should log in via Single Sign-On (SSO).\",\n    \"9-0\": \"ssoId\",\n    \"9-1\": \"string\",\n    \"9-2\": \"Optional. Used in conjunction with the <code>sso</code> field to store the SSO identifier for the user.\",\n    \"10-0\": \"defaultRoleTemplateId\",\n    \"10-1\": \"string\",\n    \"10-2\": \"Optional. ID of the default <a href=\\\"/roletemplates\\\">Role Template</a> to use when user is added to a <a href=\\\"/projects\\\">Project</a>.\"\n  },\n  \"cols\": 3,\n  \"rows\": 11\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Address Properties\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Attribute\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Comments\",\n    \"0-0\": \"address1\",\n    \"0-1\": \"string\",\n    \"0-2\": \"Street address.\",\n    \"1-0\": \"address2\",\n    \"1-1\": \"string\",\n    \"1-2\": \"Additional line used for apartment, suite or floor number.\",\n    \"2-0\": \"city\",\n    \"2-1\": \"string\",\n    \"2-2\": \"Name of the city.\",\n    \"3-0\": \"province\",\n    \"3-1\": \"string\",\n    \"3-2\": \"Name of the state or province.\",\n    \"4-0\": \"postalCode\",\n    \"4-1\": \"string\",\n    \"4-2\": \"Postal code of the mailing address.\",\n    \"5-0\": \"country\",\n    \"5-1\": \"string\",\n    \"5-2\": \"Name of the contry\"\n  },\n  \"cols\": 3,\n  \"rows\": 6\n}\n[/block]","updates":[],"order":4,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5488258fc178b40b00aa2ef8","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,"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"},"createdAt":"2014-12-10T10:50:55.960Z","githubsync":"","parentDoc":null,"__v":21,"project":"54343170fa5527080064f449","user":"54343147fa5527080064f43f","editedParams2":true}

postCreate User

Creates a new user

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

notify:
booleantrue
True to send user an email containing their username and login link

Body Params

userName:
required
string
Optional. Must be unique. May only contain letters, numbers, periods, dashes, underscores and @ symbols.
password:
required
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.
firstName:
required
string
lastName:
required
string
company:
string
email:
string
phone:
string
mobile:
string
address:
object
Address object
sso:
string
Optional. Set to true if user should log in via Single Sign-On (SSO).
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.
tags:
stringBoston,Producer
Comma separated list of tags

Result Format


Documentation

Users are at the core of all MediaSilo applications. In addition to containing a user's name, address and contact information, the User object contains an array of Roles that enable a user to perform certain tasks within the scope of an Account or Project, and an array of Tags that can be used to group, sort and filter user lists. [block:callout] { "type": "info", "title": "Users must be assigned to projects to access assets", "body": "All assets are organized into projects, and a user must be assigned to a project to work with the assets within it. Once your user has been created, you will need to [assign them to a project](http://docs.mediasilo.com/v3.0/docs/add-user-to-project) in order for the user to access MediaSilo functionality." } [/block] [block:code] { "codes": [ { "code": "// Sample payload for creating a user\n{\n \"userName\": \"johndoe\",\n \"password\": \"[email protected]@ssw0rd!\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"company\": \"MediaSilo\",\n \"email\": \"[email protected]\",\n \"phone\": \"555 444 3333\",\n \"mobile\": \"555 222 1111\",\n \"address\": {\n \"address1\": \"123 Main Street\",\n \"address2\": \"Suite 456\",\n \"city\": \"Boston\",\n \"province\": \"MA\",\n \"postalCode\": \"02111\",\n \"country\": \"United States\"\n },\n \"sso\": true,\n \"ssoId\": \"mySsoId\",\n \"defaultRoleTemplateId\": \"448aeb72-4a5d-4b76-b3bb-fa5935f47244\"\n}", "language": "json" } ] } [/block] [block:api-header] { "type": "basic", "title": "Attributes" } [/block] [block:parameters] { "data": { "h-0": "Attributes", "h-1": "Types", "h-2": "Comments", "0-0": "userName", "0-1": "string", "0-2": "Optional. Must be unique. May only contain letters, numbers, periods, dashes, underscores and @ symbols.", "1-0": "password", "1-1": "string", "1-2": "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]#$%^&amp;*,. For security, your password cannot contain your username.", "2-0": "firstName", "2-1": "string", "2-2": "Optional", "3-0": "lastName", "3-1": "string", "3-2": "Optional", "4-0": "company", "4-1": "string", "4-2": "Optional", "5-0": "email", "5-1": "string", "5-2": "Required", "6-0": "mobile", "6-1": "string", "6-2": "Optional", "7-0": "address", "7-1": "string", "7-2": "Optional. See below for description of address object.", "8-0": "sso", "8-1": "boolean", "8-2": "Optional. Set to true if user should log in via Single Sign-On (SSO).", "9-0": "ssoId", "9-1": "string", "9-2": "Optional. Used in conjunction with the <code>sso</code> field to store the SSO identifier for the user.", "10-0": "defaultRoleTemplateId", "10-1": "string", "10-2": "Optional. ID of the default <a href=\"/roletemplates\">Role Template</a> to use when user is added to a <a href=\"/projects\">Project</a>." }, "cols": 3, "rows": 11 } [/block] [block:api-header] { "type": "basic", "title": "Address Properties" } [/block] [block:parameters] { "data": { "h-0": "Attribute", "h-1": "Type", "h-2": "Comments", "0-0": "address1", "0-1": "string", "0-2": "Street address.", "1-0": "address2", "1-1": "string", "1-2": "Additional line used for apartment, suite or floor number.", "2-0": "city", "2-1": "string", "2-2": "Name of the city.", "3-0": "province", "3-1": "string", "3-2": "Name of the state or province.", "4-0": "postalCode", "4-1": "string", "4-2": "Postal code of the mailing address.", "5-0": "country", "5-1": "string", "5-2": "Name of the contry" }, "cols": 3, "rows": 6 } [/block]

User Information

Try It Out

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