{"type":"doc","content":[{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"toc","parameters":{"macroParams":{"minLevel":{"value":"2"},"maxLevel":{"value":"2"},"outline":{"value":"false"},"type":{"value":"flat"},"separator":{"value":"brackets"},"printable":{"value":"true"}},"macroMetadata":{"macroId":{"value":"0a0aa308-ed95-4f73-9012-84f03324e574"},"schemaVersion":{"value":"1"},"title":"Table of Contents"}},"localId":"109b3889-d97b-48a5-91c8-52e327ebb011"}},{"type":"heading","attrs":{"level":2},"content":[{"text":"Overview","type":"text"}]},{"type":"paragraph","content":[{"text":"Check the list of available endpoints and methods to create and modify users using the Provisioning API.","type":"text"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"Internal and external users","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"Some of the actions you can perform using these endpoints apply to different groups of users (internal and external users) so its important to know the difference between them:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Internal users","type":"text","marks":[{"type":"strong"}]},{"text":" are registered into the platform with their own password. Internal users are required to validate their email, and they can be added as domain owners.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"External users ","type":"text","marks":[{"type":"strong"}]},{"text":"are registered into a third party platform, and have limited access to the platform. They need to be registered as external users, but do not need to have their emails validated. They cannot be domain owners.","type":"text"}]}]}]}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"fc9c7941-a6d7-49cd-8ef3-d38dbaaeb47e"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[395.0]},"content":[{"type":"paragraph","content":[{"text":"Endpoints and methods","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[283.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[395.0]},"content":[{"type":"paragraph","content":[{"type":"status","attrs":{"color":"yellow","style":"bold","text":"GET","localId":"97382dfd-3719-459b-b16d-e8a6f032472d"}},{"text":"/user/email/{userEmail}","type":"text","marks":[{"type":"code"}]},{"text":"see below","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"link","attrs":{"href":"#path1"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[283.0]},"content":[{"type":"paragraph","content":[{"text":"Get user info based on email.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[395.0]},"content":[{"type":"paragraph","content":[{"type":"status","attrs":{"color":"yellow","style":"bold","text":"GET","localId":"b5eb9db6-2669-4d31-abde-3a8c73ade98b"}},{"text":" ","type":"text"},{"text":"/user/domain/{domainName}","type":"text","marks":[{"type":"code"}]},{"text":"see below","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"link","attrs":{"href":"#path2"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[283.0]},"content":[{"type":"paragraph","content":[{"text":"Get information about the users in a domain.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[395.0]},"content":[{"type":"paragraph","content":[{"type":"status","attrs":{"color":"yellow","style":"bold","text":"GET","localId":"d8ef3d64-517f-4a80-abbb-29361c948278"}},{"text":" ","type":"text"},{"text":"/user/email/{userEmail}/domain/{domainName}","type":"text","marks":[{"type":"code"}]},{"text":"see below","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"link","attrs":{"href":"#path3"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[283.0]},"content":[{"type":"paragraph","content":[{"text":"Get user info based on email and domain.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[395.0]},"content":[{"type":"paragraph","content":[{"type":"status","attrs":{"color":"yellow","style":"bold","text":"GET","localId":"468a3a0e-164d-4a52-87c6-8b4ce1527a51"}},{"text":" ","type":"text"},{"text":"/user/internal/{id}","type":"text","marks":[{"type":"code"}]},{"text":"see below","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"link","attrs":{"href":"#path6"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[283.0]},"content":[{"type":"paragraph","content":[{"text":"Get user info based on internal ID","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[395.0]},"content":[{"type":"paragraph","content":[{"type":"status","attrs":{"color":"yellow","style":"bold","text":"GET","localId":"b09f1cec-1182-41c8-8638-35cd28cdc641"}},{"text":" ","type":"text"},{"text":"/user/internal/{id}/domain/{domainName}","type":"text","marks":[{"type":"code"}]},{"text":"see below","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"link","attrs":{"href":"#path5"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[283.0]},"content":[{"type":"paragraph","content":[{"text":"Get user info based on domain and internal ID.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[395.0]},"content":[{"type":"paragraph","content":[{"type":"status","attrs":{"color":"yellow","style":"bold","text":"GET","localId":"d816fc51-06f2-4b39-9af9-f0794335b816"}},{"text":" ","type":"text"},{"text":"/user/external/{id}/domain/{domainName}","type":"text","marks":[{"type":"code"}]},{"text":"see below","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"link","attrs":{"href":"#path4"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[283.0]},"content":[{"type":"paragraph","content":[{"text":"Get user info based on domain and external ID.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[395.0]},"content":[{"type":"paragraph","content":[{"type":"status","attrs":{"color":"green","style":"bold","text":"POST","localId":"a8beaa68-6f8a-4b20-8d18-428eb4104981"}},{"text":" ","type":"text"},{"text":"/user/internal","type":"text","marks":[{"type":"code"}]},{"text":"see below","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"link","attrs":{"href":"#path7"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[283.0]},"content":[{"type":"paragraph","content":[{"text":"Add an internal user to a domain.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[395.0]},"content":[{"type":"paragraph","content":[{"type":"status","attrs":{"color":"green","style":"bold","text":"POST","localId":"b3220a5c-8819-4b3b-bdf4-a41153887334"}},{"text":" ","type":"text"},{"text":"/user/external","type":"text","marks":[{"type":"code"}]},{"text":"see below","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"link","attrs":{"href":"#path8"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[283.0]},"content":[{"type":"paragraph","content":[{"text":"Add an external user to a domain.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[395.0]},"content":[{"type":"paragraph","content":[{"type":"status","attrs":{"color":"green","style":"bold","text":"POST","localId":"2d2c6b64-924a-4055-aa91-c3dbed7b4417"}},{"text":" ","type":"text"},{"text":"/user/email/{userEmail}/domain/{domainName}/disable","type":"text","marks":[{"type":"code"}]},{"text":"see below","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"link","attrs":{"href":"#path9"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[283.0]},"content":[{"type":"paragraph","content":[{"text":"Disable a user in a domain.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[395.0]},"content":[{"type":"paragraph","content":[{"type":"status","attrs":{"color":"green","style":"bold","text":"POST","localId":"a857b85b-e581-4688-9e34-cb900e9e5dac"}},{"text":" ","type":"text"},{"text":"/user/email/{userEmail}/domain/{domainName}/enable","type":"text","marks":[{"type":"code"}]},{"text":"see below","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"link","attrs":{"href":"#path10"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[283.0]},"content":[{"type":"paragraph","content":[{"text":"Enable a user in a domain.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[395.0]},"content":[{"type":"paragraph","content":[{"type":"status","attrs":{"color":"blue","style":"bold","text":"PUT","localId":"ee196205-a9cf-473c-a5ff-978e9257e720"}},{"text":" ","type":"text"},{"text":"/user/email/{userEmail}/domain/{domainName}/role","type":"text","marks":[{"type":"code"}]},{"text":"see below","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"link","attrs":{"href":"#path11"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[283.0]},"content":[{"type":"paragraph","content":[{"text":"Set the roles of a user in a domain.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[395.0]},"content":[{"type":"paragraph","content":[{"type":"status","attrs":{"color":"blue","style":"bold","text":"PUT","localId":"b33ee925-f47b-40d6-bea3-ec117528a07f"}},{"text":" ","type":"text"},{"text":"/user/email/{userEmail}/domain/{domainName}/role/{roleName}","type":"text","marks":[{"type":"code"}]},{"text":"see below","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"link","attrs":{"href":"#path12"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[283.0]},"content":[{"type":"paragraph","content":[{"text":"Change the role of a user in a domain.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[395.0]},"content":[{"type":"paragraph","content":[{"type":"status","attrs":{"color":"blue","style":"bold","text":"PUT","localId":"9749f238-d483-46fe-801e-d0111c7b4984"}},{"text":" ","type":"text"},{"text":"/user/internal/{id}","type":"text","marks":[{"type":"code"}]},{"text":"see below","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"link","attrs":{"href":"#path13"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[283.0]},"content":[{"type":"paragraph","content":[{"text":"Update user info.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[395.0]},"content":[{"type":"paragraph","content":[{"type":"status","attrs":{"color":"red","style":"bold","text":"DELETE","localId":"a7315ab1-dfef-4e4c-8572-f7e20496cb59"}},{"text":" ","type":"text"},{"text":"/user/email/{userEmail}/domain/{domainName}","type":"text","marks":[{"type":"code"}]},{"text":"see below","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"link","attrs":{"href":"#path14"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[283.0]},"content":[{"type":"paragraph","content":[{"text":"Delete a user from a domain.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[395.0]},"content":[{"type":"paragraph","content":[{"type":"status","attrs":{"color":"red","style":"bold","text":"DELETE","localId":"1b48a423-ad87-4e43-83e5-77bce16194dd"}},{"text":" ","type":"text"},{"text":"/user/email/{userEmail}/domain/{domainName}/role","type":"text","marks":[{"type":"code"}]},{"text":"see below","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"link","attrs":{"href":"#path15"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[283.0]},"content":[{"type":"paragraph","content":[{"text":"Remove roles from a user.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Endpoints and methods","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"anchor","parameters":{"macroParams":{"":{"value":"path1"},"legacyAnchorId":{"value":"Useroperations-path1"}},"macroMetadata":{"macroId":{"value":"f3131094-bc1e-492f-ade0-06397a6a8b8d"},"schemaVersion":{"value":"1"},"title":"Anchor"}},"localId":"445c10d4-8f80-411a-aeaa-7d53785a469c"}},{"text":" ","type":"text"},{"text":"GET ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#ff991f"}},{"type":"strong"}]},{"text":"/user/email/{userEmail}","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Get basic user info based on email. The information retrieved is not related to any specific domain.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Request","type":"text"}]},{"type":"paragraph","content":[{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.migration","extensionKey":"__confluenceADFMigrationUnsupportedContentInternalExtension__","text":"","parameters":{"cxhtml":"

Path parameters

","nestedContent":{"type":"doc","content":[{"type":"heading","attrs":{"level":4},"content":[{"text":"Path parameters","type":"text"}]}],"version":1}}}}]},{"type":"paragraph","content":[{"text":"Add the following path parameters as part of the endpoint:","type":"text"}]},{"type":"table","attrs":{"layout":"full-width","localId":"09c1c104-f136-4f57-8b60-f4e6c060dd4b"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[134.0]},"content":[{"type":"paragraph","content":[{"text":"Parameter","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[121.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[395.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[134.0]},"content":[{"type":"paragraph","content":[{"text":"id","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[121.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[395.0]},"content":[{"type":"paragraph","content":[{"text":"External ID of the user.","type":"text"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"How to get the ID of an external user?","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"You can use the ","type":"text"},{"text":"GET","type":"text","marks":[{"type":"textColor","attrs":{"color":"#ff991f"}},{"type":"strong"}]},{"text":" ","type":"text"},{"text":"/user/domain/{domainName}","type":"text","marks":[{"type":"code"}]},{"text":" endpoint to get the IDs of all the users in a domain.","type":"text"}]},{"type":"paragraph","content":[{"text":"If theres any external users, you will get their IDs in the response, in the ","type":"text"},{"text":"externalId","type":"text","marks":[{"type":"code"}]},{"text":" parameter.","type":"text"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[134.0]},"content":[{"type":"paragraph","content":[{"text":"domainName","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[121.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[395.0]},"content":[{"type":"paragraph","content":[{"text":"Enter the name of the required domain. You must enter the full domain name using the format ","type":"text"},{"text":"{domainName}@{resellerName}","type":"text","marks":[{"type":"em"}]}]}]}]}]},{"type":"paragraph","content":[{"text":"Find below a request example:","type":"text"}]},{"type":"codeBlock","content":[{"text":"https://api-us.devo.com/probio/user/external/2456-sgfd-2344/domain/domainName@resellerName","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Response","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"72d55dfc-2f0d-4001-9b48-d30a7e15b218"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[148.0]},"content":[{"type":"paragraph","content":[{"text":"Code","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[502.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[148.0]},"content":[{"type":"paragraph","content":[{"text":"200","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[502.0]},"content":[{"type":"paragraph","content":[{"text":"Successful response. User info retrieved.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"email\": \"user@devo.com,\n \"userName\": \"Rita\",\n \"role\": \"ADMIN\",\n \"externalId\": \"2456-sgfd-2344\",\n \"domain\": \"domainName@resellerName\",\n \"owner\": false,\n \"status\": \"active\",\n \"roleList\": [\n \"ADMIN\"\n ]\n}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[148.0]},"content":[{"type":"paragraph","content":[{"text":"4xx","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[502.0]},"content":[{"type":"paragraph","content":[{"text":"Bad request.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"error\": {\n \"code\": 4xx,\n \"message\": \"string\"\n }\n}","type":"text"}]}]}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"anchor","parameters":{"macroParams":{"":{"value":"path7"},"legacyAnchorId":{"value":"Useroperations-path7"}},"macroMetadata":{"macroId":{"value":"d6eb4d48fc46f8e8d262411ddbcffccd"},"schemaVersion":{"value":"1"},"title":"Anchor"}},"localId":"d3bdfec8-2d54-468a-871f-f5613217f2aa"}},{"text":" ","type":"text"},{"text":"POST","type":"text","marks":[{"type":"textColor","attrs":{"color":"#36b37e"}},{"type":"strong"}]},{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#ff991f"}},{"type":"strong"}]},{"text":"/user/internal","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Add an internal user to a multitenant domain.","type":"text"}]},{"type":"paragraph","content":[{"text":"Every user in a domain needs to have at least one role assigned to them, either one of the default roles in the application or a custom role. While creating users in a domain, keep in mind the following restrictions:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Internal users cannot be used immediately after creation - they must first be activated through a link sent to the email address provided. The activation process also requires the user to create a password.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The first user added to a new domain must be internal and must be the domain owner. Owners cannot be deleted, and a domain can only have one owner.","type":"text"}]}]}]},{"type":"panel","attrs":{"panelType":"warning"},"content":[{"type":"paragraph","content":[{"text":"Youll need the multitenant API keys to create the first user in the domain, and its role must be ","type":"text"},{"text":"OWNER","type":"text","marks":[{"type":"code"}]},{"text":". Check an example of this below.","type":"text"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"To assign a user (new or existing) as a domain owner, use the role","type":"text"},{"text":"OWNER","type":"text","marks":[{"type":"code"}]},{"text":"when creating the user. This will create the user with the role","type":"text"},{"text":"ADMIN","type":"text","marks":[{"type":"code"}]},{"text":"but with ","type":"text"},{"text":"OWNER","type":"text","marks":[{"type":"code"}]},{"text":" privileges. The ","type":"text"},{"text":"ADMIN","type":"text","marks":[{"type":"code"}]},{"text":" role is exclusive and cannot be combined with other roles.","type":"text"}]}]}]},{"type":"panel","attrs":{"panelType":"warning"},"content":[{"type":"paragraph","content":[{"text":"Notice that even though the role ","type":"text"},{"text":"OWNER","type":"text","marks":[{"type":"code"}]},{"text":" is used to assign a user the ownership of a domain, this is interpreted as ","type":"text"},{"text":"ADMIN","type":"text","marks":[{"type":"code"}]},{"text":" role, flagged as ","type":"text"},{"text":"OWNER","type":"text","marks":[{"type":"code"}]},{"text":", so the actual role (for policies, permissions) is actually ","type":"text"},{"text":"ADMIN","type":"text","marks":[{"type":"code"}]},{"text":", and that value will be returned in the responses (along with a boolean ","type":"text"},{"text":"OWNER","type":"text","marks":[{"type":"code"}]},{"text":" flag).","type":"text"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"This method can be also used to add an existing user to a different domain. In this case, the user will keep their original user name and phone number, ignoring any new value provided for them. The field ","type":"text"},{"text":"externalId","type":"text","marks":[{"type":"code"}]},{"text":" is ignored too since it only has meaning for external users (who might not have a password in the platform).","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Request","type":"text"}]},{"type":"paragraph","content":[{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.migration","extensionKey":"__confluenceADFMigrationUnsupportedContentInternalExtension__","text":"","parameters":{"cxhtml":"

Query string parameters

","nestedContent":{"type":"doc","content":[{"type":"heading","attrs":{"level":4},"content":[{"text":"Query string parameters","type":"text"}]}],"version":1}}}}]},{"type":"paragraph","content":[{"text":"Query string parameters are added after the path parameters, preceded by a question mark (","type":"text"},{"text":"?","type":"text","marks":[{"type":"code"}]},{"text":") and separated by an ampersand ()","type":"text"}]},{"type":"table","attrs":{"layout":"full-width","localId":"14afae3d-7970-43a3-af31-ea978a8e8a31"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[158.0]},"content":[{"type":"paragraph","content":[{"text":"Parameter","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[99.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[393.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[158.0]},"content":[{"type":"paragraph","content":[{"text":"skipMailValidation","type":"text","marks":[{"type":"code"}]},{"text":" required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[99.0]},"content":[{"type":"paragraph","content":[{"text":"boolean","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[393.0]},"content":[{"type":"paragraph","content":[{"text":"Set this to ","type":"text"},{"text":"true","type":"text","marks":[{"type":"code"}]},{"text":" to skip the email address validation step when creating a user for the domain. In this case, the user must already exist in the platform and therefore already have a password. Default value is ","type":"text"},{"text":"false","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]},{"type":"panel","attrs":{"panelType":"warning"},"content":[{"type":"paragraph","content":[{"text":"Note that in order to use this parameter, you must use multitenant domain credentials to authorize your request.","type":"text"}]}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Request body","type":"text"}]},{"type":"paragraph","content":[{"text":"The request JSON body must include the ","type":"text"},{"text":"userInfo","type":"text","marks":[{"type":"code"}]},{"text":" object with the following key-value pairs:","type":"text"}]},{"type":"table","attrs":{"layout":"full-width","localId":"1ba5f528-5d28-4267-9181-b81a9a949d32"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[158.0]},"content":[{"type":"paragraph","content":[{"text":"Parameter","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[99.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[393.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[158.0]},"content":[{"type":"paragraph","content":[{"text":"domain","type":"text","marks":[{"type":"code"}]},{"text":" required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[99.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[393.0]},"content":[{"type":"paragraph","content":[{"text":"Domain name. Must match the expression ","type":"text"},{"text":"^[A-Za-z]A-Za-z0-9_-?$.","type":"text","marks":[{"type":"em"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[158.0]},"content":[{"type":"paragraph","content":[{"text":"userName","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[99.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[393.0]},"content":[{"type":"paragraph","content":[{"text":"Name of the new user. Must match the expression ","type":"text"},{"text":"^(([a-zA-Z0-9-])+([ _'.@-]))([a-zA-Z0-9-])$.","type":"text","marks":[{"type":"em"}]}]},{"type":"paragraph","content":[{"text":"This field will be ignored if you are adding an already existing user to a different domain, and the current value will be kept.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[158.0]},"content":[{"type":"paragraph","content":[{"text":"email","type":"text","marks":[{"type":"code"}]},{"text":" required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[99.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[393.0]},"content":[{"type":"paragraph","content":[{"text":"Enter the email address of the new user.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[158.0]},"content":[{"type":"paragraph","content":[{"text":"role","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[99.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[393.0]},"content":[{"type":"paragraph","content":[{"text":"Role of the new user. Basic roles in Devo are:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"OWNER","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"ADMIN","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"NO_PRIVILEGES","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"paragraph","content":[{"text":"Custom roles must match the expression ","type":"text"},{"text":"^(([a-zA-Z0-9])+([ _-]))([a-zA-Z0-9])$.","type":"text","marks":[{"type":"em"}]}]},{"type":"paragraph","content":[{"text":"Check more info about roles at the top of this endpoint section.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[158.0]},"content":[{"type":"paragraph","content":[{"text":"phone","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[99.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[393.0]},"content":[{"type":"paragraph","content":[{"text":"Phone number of the new user. Must match the expression ","type":"text"},{"text":"^+(?:[0-9] ?){6,14}[0-9]$.","type":"text","marks":[{"type":"em"}]}]},{"type":"paragraph","content":[{"text":"This field will be ignored if you are adding an already existing user to a different domain, and the current value will be kept.","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"text":"Find below a request example:","type":"text"}]},{"type":"codeBlock","content":[{"text":"https://api-us.devo.com/probio/user/internal?skipValidation=false","type":"text"}]},{"type":"paragraph","content":[{"text":"And this is an example of a request body, including the required JSON object. In this example, we are adding the first user (owner) of a domain:","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"domain\": \"domainName@resellerName\",\n \"userName\": \"Frank\",\n \"email\": \"user@devo.com\",\n \"role\": \"OWNER\"\n}","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Response","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"0ea246e4-cd97-401d-9602-e7ad6e2bd323"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[109.0]},"content":[{"type":"paragraph","content":[{"text":"Code","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[541.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[109.0]},"content":[{"type":"paragraph","content":[{"text":"200","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[541.0]},"content":[{"type":"paragraph","content":[{"text":"Successful response. User added to the given domain.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"email\": \"user@devo.com\",\n \"userName\": \"Frank\",\n \"role\": \"ADMIN\",\n \"domain\": \"domainName@resellerName\",\n \"owner\": true,\n \"status\": \"pending\",\n \"roleList\": [\n \"ADMIN\"\n ]\n}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[109.0]},"content":[{"type":"paragraph","content":[{"text":"4xx","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[541.0]},"content":[{"type":"paragraph","content":[{"text":"Bad request.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"error\": {\n \"code\": 4xx,\n \"message\": \"string\"\n }\n}","type":"text"}]}]}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"anchor","parameters":{"macroParams":{"":{"value":"path8"},"legacyAnchorId":{"value":"Useroperations-path8"}},"macroMetadata":{"macroId":{"value":"644046d33dad6b4afe55a170f3c64c09"},"schemaVersion":{"value":"1"},"title":"Anchor"}},"localId":"608a2a51-4a0c-4701-b2df-bed25515300b"}},{"text":" ","type":"text"},{"text":"POST","type":"text","marks":[{"type":"textColor","attrs":{"color":"#36b37e"}},{"type":"strong"}]},{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#ff991f"}},{"type":"strong"}]},{"text":"/user/external","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Add an external user to a multitenant domain.","type":"text"}]},{"type":"paragraph","content":[{"text":"Every user in a domain needs to have at least one role assigned to them, either one of the default roles in the application or a custom role. When you create external users in a domain, keep in mind the following restrictions:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"An external ID must be provided for the user - normally a valid identifier at the client platform. This method only works for clients belonging to a multitenant structure.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"External users cannot be domain owners. They also do not require a username and password if the reseller configuration allows for it through federated authentication.","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Request","type":"text"}]},{"type":"paragraph","content":[{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.migration","extensionKey":"__confluenceADFMigrationUnsupportedContentInternalExtension__","text":"","parameters":{"cxhtml":"

Request body

","nestedContent":{"type":"doc","content":[{"type":"heading","attrs":{"level":4},"content":[{"text":"Request body","type":"text"}]}],"version":1}}}}]},{"type":"paragraph","content":[{"text":"The request JSON body must include the ","type":"text"},{"text":"userInfo","type":"text","marks":[{"type":"code"}]},{"text":" object with the following key-value pairs:","type":"text"}]},{"type":"table","attrs":{"layout":"full-width","localId":"97bcc6ad-6096-4fc1-932d-6ad727134c58"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[158.0]},"content":[{"type":"paragraph","content":[{"text":"Parameter","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[99.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[393.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[158.0]},"content":[{"type":"paragraph","content":[{"text":"domain","type":"text","marks":[{"type":"code"}]},{"text":" required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[99.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[393.0]},"content":[{"type":"paragraph","content":[{"text":"Domain name. Must match the expression ","type":"text"},{"text":"^[A-Za-z]A-Za-z0-9_-?$.","type":"text","marks":[{"type":"em"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[158.0]},"content":[{"type":"paragraph","content":[{"text":"userName","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[99.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[393.0]},"content":[{"type":"paragraph","content":[{"text":"Name of the new user. Must match the expression ","type":"text"},{"text":"^(([a-zA-Z0-9-])+([ _'.@-]))([a-zA-Z0-9-])$.","type":"text","marks":[{"type":"em"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[158.0]},"content":[{"type":"paragraph","content":[{"text":"email","type":"text","marks":[{"type":"code"}]},{"text":" required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[99.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[393.0]},"content":[{"type":"paragraph","content":[{"text":"Enter the email address of the new user.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[158.0]},"content":[{"type":"paragraph","content":[{"text":"externalId","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[99.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[393.0]},"content":[{"type":"paragraph","content":[{"text":"User identifier in the external system. The maximum number of characters is 256.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[158.0]},"content":[{"type":"paragraph","content":[{"text":"role","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[99.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[393.0]},"content":[{"type":"paragraph","content":[{"text":"Role of the new user. Must match the expression ","type":"text"},{"text":"^(([a-zA-Z0-9])+([ _-]))([a-zA-Z0-9])$.","type":"text","marks":[{"type":"em"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[158.0]},"content":[{"type":"paragraph","content":[{"text":"phone","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[99.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[393.0]},"content":[{"type":"paragraph","content":[{"text":"Phone number of the new user. Must match the expression ","type":"text"},{"text":"^+(?:[0-9] ?){6,14}[0-9]$.","type":"text","marks":[{"type":"em"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[158.0]},"content":[{"type":"paragraph","content":[{"text":"owner","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[99.0]},"content":[{"type":"paragraph","content":[{"text":"boolean","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[393.0]},"content":[{"type":"paragraph","content":[{"text":"Set this parameter to ","type":"text"},{"text":"true","type":"text","marks":[{"type":"code"}]},{"text":" if the user is the owner of the current domain.","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"text":"Find below a request example:","type":"text"}]},{"type":"codeBlock","content":[{"text":"https://api-us.devo.com/probio/user/external","type":"text"}]},{"type":"paragraph","content":[{"text":"And this is an example of a request body, including the required JSON object:","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"domain\": \"domainName@resellerName\n \"userName\": \"Lara\",\n \"email\": \"user@devo.com\",\n \"externalId\": \"12345\",\n \"role\": \"ADMIN\"\n}","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Response","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"89a4b40b-dcec-4f19-b85b-0783dcbba752"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[111.0]},"content":[{"type":"paragraph","content":[{"text":"Code","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[539.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[111.0]},"content":[{"type":"paragraph","content":[{"text":"200","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[539.0]},"content":[{"type":"paragraph","content":[{"text":"Successful response. User added.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"email\": \"user@devo.com\",\n \"userName\": \"Lara\",\n \"role\": \"ADMIN\",\n \"externalId\": \"12345\",\n \"domain\": \"domainName@resellerName\",\n \"owner\": false,\n \"status\": \"active\",\n \"roleList\": [\n \"ADMIN\"\n ]\n}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[111.0]},"content":[{"type":"paragraph","content":[{"text":"4xx","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[539.0]},"content":[{"type":"paragraph","content":[{"text":"Bad request.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"error\": {\n \"code\": 4xx,\n \"message\": \"string\"\n }\n}","type":"text"}]}]}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"anchor","parameters":{"macroParams":{"":{"value":"path9"},"legacyAnchorId":{"value":"Useroperations-path9"}},"macroMetadata":{"macroId":{"value":"c046c9060c2f2f5706c8438840d8ba0c"},"schemaVersion":{"value":"1"},"title":"Anchor"}},"localId":"6d0fd75d-70a9-4c39-a14f-2a878ff0b382"}},{"text":" ","type":"text"},{"text":"POST","type":"text","marks":[{"type":"textColor","attrs":{"color":"#36b37e"}},{"type":"strong"}]},{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#ff991f"}},{"type":"strong"}]},{"text":"/user/email/{userEmail}/domain/{domainName}/disable","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Disable a user in a given domain. Note that this action does not remove the user from the domain. Users can be re-enabled anytime.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Request","type":"text"}]},{"type":"paragraph","content":[{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.migration","extensionKey":"__confluenceADFMigrationUnsupportedContentInternalExtension__","text":"","parameters":{"cxhtml":"

Path parameters

","nestedContent":{"type":"doc","content":[{"type":"heading","attrs":{"level":4},"content":[{"text":"Path parameters","type":"text"}]}],"version":1}}}}]},{"type":"paragraph","content":[{"text":"Add the following path parameters as part of the endpoint:","type":"text"}]},{"type":"table","attrs":{"layout":"full-width","localId":"895b3fd5-5c63-4cb1-a2dd-277b1504fe56"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[163.0]},"content":[{"type":"paragraph","content":[{"text":"Parameter","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[121.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[366.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[163.0]},"content":[{"type":"paragraph","content":[{"text":"userEmail","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[121.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[366.0]},"content":[{"type":"paragraph","content":[{"text":"Enter the email of the required user.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[163.0]},"content":[{"type":"paragraph","content":[{"text":"domainName","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[121.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[366.0]},"content":[{"type":"paragraph","content":[{"text":"Enter the name of the required domain. You must enter the full domain name using the format ","type":"text"},{"text":"{domainName}@{resellerName}","type":"text","marks":[{"type":"em"}]}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Query string parameters","type":"text"}]},{"type":"paragraph","content":[{"text":"Query string parameters are added after the path parameters, preceded by a question mark (","type":"text"},{"text":"?","type":"text","marks":[{"type":"code"}]},{"text":") and separated by an ampersand ()","type":"text"}]},{"type":"table","attrs":{"layout":"full-width","localId":"b958c6ec-4e8b-4c49-ba54-4f36a002d6c4"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[158.0]},"content":[{"type":"paragraph","content":[{"text":"Parameter","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[99.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[393.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[158.0]},"content":[{"type":"paragraph","content":[{"text":"keepExisting","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[99.0]},"content":[{"type":"paragraph","content":[{"text":"boolean","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[393.0]},"content":[{"type":"paragraph","content":[{"text":"Set this to ","type":"text"},{"text":"true","type":"text","marks":[{"type":"code"}]},{"text":" to keep the current roles of the user, plus the new ones added through this request. The default value is ","type":"text"},{"text":"false","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Request body","type":"text"}]},{"type":"paragraph","content":[{"text":"The request JSON body must include the following key-value pairs:","type":"text"}]},{"type":"table","attrs":{"layout":"full-width","localId":"1bb2cb2d-6f94-4cc9-b5f3-d1fa6de422ec"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[158.0]},"content":[{"type":"paragraph","content":[{"text":"Parameter","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[99.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[393.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[158.0]},"content":[{"type":"paragraph","content":[{"text":"roles","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[99.0]},"content":[{"type":"paragraph","content":[{"text":"object","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[393.0]},"content":[{"type":"paragraph","content":[{"text":"Enter the list of role names separated by commas. Basic roles in Devo are:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"OWNER","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"ADMIN","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"NO_PRIVILEGES","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"paragraph","content":[{"text":"Custom roles must match the expression ","type":"text"},{"text":"^(([a-zA-Z0-9])+([ _-]))([a-zA-Z0-9])$.","type":"text","marks":[{"type":"em"}]}]}]}]}]},{"type":"paragraph","content":[{"text":"Find below a request example:","type":"text"}]},{"type":"codeBlock","content":[{"text":"https://api-us.devo.com/probio/user/email/user@devo.com/domain/domainName@resellerName/role?keepExisting=true","type":"text"}]},{"type":"paragraph","content":[{"text":"And this is an example of a request body, including the required JSON object:","type":"text"}]},{"type":"codeBlock","content":[{"text":"[\n \"role1\", \"role2\", \"role3\"\n]","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Response","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"9f9135d6-339f-4e53-8ecd-2b4e68ba8b39"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[107.0]},"content":[{"type":"paragraph","content":[{"text":"Code","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[543.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[107.0]},"content":[{"type":"paragraph","content":[{"text":"200","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[543.0]},"content":[{"type":"paragraph","content":[{"text":"Successful response. Roles updated.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[107.0]},"content":[{"type":"paragraph","content":[{"text":"4xx","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[543.0]},"content":[{"type":"paragraph","content":[{"text":"Bad request.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"error\": {\n \"code\": 4xx,\n \"message\": \"string\"\n }\n}","type":"text"}]}]}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"anchor","parameters":{"macroParams":{"":{"value":"path12"},"legacyAnchorId":{"value":"Useroperations-path12"}},"macroMetadata":{"macroId":{"value":"6be873c567b0cbe178994ca0fe5f43cd"},"schemaVersion":{"value":"1"},"title":"Anchor"}},"localId":"1c56fe4a-860d-40b7-b1d7-da211b6489da"}},{"text":" ","type":"text"},{"text":"PUT","type":"text","marks":[{"type":"textColor","attrs":{"color":"#4c9aff"}},{"type":"strong"}]},{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#ff991f"}},{"type":"strong"}]},{"text":"/user/email/{userEmail}/domain/{domainName}/role/{roleName}","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Change the role of a user in a given domain. Note that this action does not add a role to the users current ones, but replace them by the selected one.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Request","type":"text"}]},{"type":"paragraph","content":[{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.migration","extensionKey":"__confluenceADFMigrationUnsupportedContentInternalExtension__","text":"","parameters":{"cxhtml":"

Path parameters

","nestedContent":{"type":"doc","content":[{"type":"heading","attrs":{"level":4},"content":[{"text":"Path parameters","type":"text"}]}],"version":1}}}}]},{"type":"paragraph","content":[{"text":"Add the following path parameters as part of the endpoint:","type":"text"}]},{"type":"table","attrs":{"layout":"full-width","localId":"d2eb0515-f6fe-4e2b-9c11-25808070b8b2"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[163.0]},"content":[{"type":"paragraph","content":[{"text":"Parameter","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[121.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[366.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[163.0]},"content":[{"type":"paragraph","content":[{"text":"id","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"required","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[121.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[366.0]},"content":[{"type":"paragraph","content":[{"text":"ID of the user to be updated.","type":"text"}]}]}]}]},{"type":"panel","attrs":{"panelType":"warning"},"content":[{"type":"paragraph","content":[{"text":"You can use either the query string parameters or request body indicated below to provide the updated values. If a request body is sent, the query string parameters will be ignored.","type":"text"}]},{"type":"paragraph","content":[{"text":"To delete an existing user value (like the phone number), set the field value to an empty string. To keep the existing value and not change it, either don't include the field in the request or set the field value to ","type":"text"},{"text":"null","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Query string parameters","type":"text"}]},{"type":"paragraph","content":[{"text":"Query string parameters are added after the path parameters, preceded by a question mark (","type":"text"},{"text":"?","type":"text","marks":[{"type":"code"}]},{"text":") and separated by an ampersand ()","type":"text"}]},{"type":"table","attrs":{"layout":"full-width","localId":"4a342c56-1dfd-43ac-ae40-fc1a7ee71e6e"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[118.0]},"content":[{"type":"paragraph","content":[{"text":"Parameter","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[112.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[420.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[118.0]},"content":[{"type":"paragraph","content":[{"text":"email","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[112.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[420.0]},"content":[{"type":"paragraph","content":[{"text":"New email address of the user.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[118.0]},"content":[{"type":"paragraph","content":[{"text":"phone","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[112.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[420.0]},"content":[{"type":"paragraph","content":[{"text":"New phone number of the user. Must match the expression ","type":"text"},{"text":"^+(?:[0-9] ?){6,14}[0-9]$.","type":"text","marks":[{"type":"em"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[118.0]},"content":[{"type":"paragraph","content":[{"text":"userName","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[112.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[420.0]},"content":[{"type":"paragraph","content":[{"text":"New name of the user. Must match the expression ","type":"text"},{"text":"^(([a-zA-Z0-9-])+([ _'.@-]))([a-zA-Z0-9-])$.","type":"text","marks":[{"type":"em"}]}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Request body","type":"text"}]},{"type":"paragraph","content":[{"text":"The request JSON body must include the following key-value pairs:","type":"text"}]},{"type":"table","attrs":{"layout":"full-width","localId":"d76c461a-d7d0-4692-95a7-43a74a17d0bc"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[115.0]},"content":[{"type":"paragraph","content":[{"text":"Parameter","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[114.0]},"content":[{"type":"paragraph","content":[{"text":"Type","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[421.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[115.0]},"content":[{"type":"paragraph","content":[{"text":"email","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[114.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[421.0]},"content":[{"type":"paragraph","content":[{"text":"New email address of the user.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[115.0]},"content":[{"type":"paragraph","content":[{"text":"phone","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[114.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[421.0]},"content":[{"type":"paragraph","content":[{"text":"New phone number of the user. Must match the expression ","type":"text"},{"text":"^+(?:[0-9] ?){6,14}[0-9]$.","type":"text","marks":[{"type":"em"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[115.0]},"content":[{"type":"paragraph","content":[{"text":"userName","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[114.0]},"content":[{"type":"paragraph","content":[{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[421.0]},"content":[{"type":"paragraph","content":[{"text":"New name of the user. Must match the expression ","type":"text"},{"text":"^(([a-zA-Z0-9-])+([ _'.@-]))([a-zA-Z0-9-])$.","type":"text","marks":[{"type":"em"}]}]}]}]}]},{"type":"paragraph","content":[{"text":"Find below a request example:","type":"text"}]},{"type":"codeBlock","content":[{"text":"https://api-us.devo.com/probio/user/internal/123-456-789","type":"text"}]},{"type":"paragraph","content":[{"text":"And this is an example of a request body, including the required JSON object:","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"userName\": \"Johnny\",\n \"phone\": \"+34678789890\"\n}","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Response","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"f96c864c-b6ed-4ae9-accd-a436e7d47674"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[107.0]},"content":[{"type":"paragraph","content":[{"text":"Code","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[543.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[107.0]},"content":[{"type":"paragraph","content":[{"text":"200","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[543.0]},"content":[{"type":"paragraph","content":[{"text":"Successful response. User info updated.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"email\": \"user@devo.com\",\n \"userName\": \"Johnny\",\n \"phone\": \"+34678789890\"\n \"id\": \"123-456-789\"\n}","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[107.0]},"content":[{"type":"paragraph","content":[{"text":"4xx","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[543.0]},"content":[{"type":"paragraph","content":[{"text":"Bad request.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"error\": {\n \"code\": 4xx,\n \"message\": \"string\"\n }\n}","type":"text"}]}]}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"anchor","parameters":{"macroParams":{"":{"value":"path14"},"legacyAnchorId":{"value":"Useroperations-path14"}},"macroMetadata":{"macroId":{"value":"067b1ffe9f56ca3c829e79e577d7a502"},"schemaVersion":{"value":"1"},"title":"Anchor"}},"localId":"dcc281f2-2880-4b92-b187-cf85721abafe"}},{"text":" ","type":"text"},{"text":"DELETE","type":"text","marks":[{"type":"textColor","attrs":{"color":"#ff5630"}},{"type":"strong"}]},{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#ff991f"}},{"type":"strong"}]},{"text":"/user/email/{userEmail}/domain/{domainName}","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Removes a user from a given domain. If the user only belongs to the given domain, all the information about the user will be deleted from the platform.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Request","type":"text"}]},{"type":"paragraph","content":[{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.migration","extensionKey":"__confluenceADFMigrationUnsupportedContentInternalExtension__","text":"","parameters":{"cxhtml":"

Browser not supported