UserCreate()

Users may be created using the Web Portal or by a Node (for example, a LASP, Access Portal, or Retailer).

Node SHALL inform the user that a User will be created, why it is being created, and that an email notification will follow.

Nodes acting on behalf of standard Users cannot create a new full access User; Users may only create a new User of the same or lesser UserClass.

API URL:

[BaseURL]/Account/{AccountID}/User

Request Method:

POST

Request Parameters:

• AccountID is the unique identifier for an Account

Request Format

XML type:

• dece:UserData-type

Required information:

• User
  • @UserClass [`urn:dece:role:user:class:full` OR `urn:dece:role:user:class:standard`]
  • Name
    • GivenName
    • SurName
      
  • ContactInfo
    • PrimaryEmail
      • Value
  • Credentials
    • Username

Optional information:

• /User/Languages/Language

  If not provided, language will be selected based on the Account’s country.

• /User/Credentials/Password

  If not provided, a random password will be generated.

Headers:

• Authorization: SAML2 assertion=[Assertion]

Response Format

Status Code:

• HTTP 201 Created

Headers:

• Location: [BaseURL]/Account/{AccountID}/User/{UserID}

  A reference to the newly created User

Errors

• SecurityContextForbidden
  • The request is not authorized
  • HTTP Status Code: 403
• AccountUserSurnameNotValid
  • /User/Name/Surname is not valid
  • HTTP Status Code: 400 Bad Request
• AccountUserPrimaryEmailNotValid
  • /User/ContactInfo/PrimaryEmail/Value is not valid
  • HTTP Status Code: 400 Bad Request
• AccountUsernameNotValid
  • /User/Credentials/Username is not valid
  • HTTP Status Code: 400 Bad Request
• AccountActiveUserCountReachedMaxLimit
  • The Account already has the maximum permitted active Users
  • HTTP Status Code: 400 Bad Request
• UserClassUnsupported
  • /User/@UserClass is set to an unsupported value
  • HTTP Status Code: 400 Bad Request
• RequestorPrivilegeInsufficientToCreateFullAccessUser
  • @UserClass of requesting User is not sufficient to create new full access Users
  • HTTP Status Code: 403 Forbidden
• RequestorNotAllowedToCreateUsers
  • @UserClass of requesting User is not sufficient to create new Users
  • HTTP Status Code: 403 Forbidden
• NotFound
  • The account with the specified AccountId was not found
  • HTTP Status Code: 404

Example

Create a new full access User for an existing Account

In the following example a Node acting on behalf of a User with a sufficient @UserClass createst a new full access User within an existing Account.

Sample Request:

POST /rest/2015/02/Account/urn:dece:accountid:org:dece:D39621A70BA347A6B098054512DCDE26/User HTTP/1.1
Host: api.uvvu.com
Authorization: SAML2 assertion=[Assertion]
Content-type: application/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<User UserClass="urn:dece:role:user:class:full" UserID="urn:dece:userid:org:dece:6EB44425B9814DDFB9E7F70C31A184C7" xmlns="http://www.decellc.org/schema/2015/03/coordinator">
    <Name>
        <GivenName>Clark</GivenName>
        <SurName>Kent1278</SurName>
    </Name>
    <ContactInfo>
        <PrimaryEmail>
            <Value>09f1f582-de1d-48c1-ab19-efc1ccb76ccc@qa.uvvu.com</Value>
        </PrimaryEmail>
    </ContactInfo>
    <Languages>
        <Language>en-US</Language>
    </Languages>
    <Credentials>
        <Username>test_-_cl-3a612a58-c942-44d9-b9c4-788084b363aa</Username>
        <Password>SuperSecret1234</Password>
    </Credentials>
</User>

Sample Response:

HTTP/1.1 201 Created
Date: [Date]
Location: https://api.uvvu.com/rest/2015/02/Account/urn:dece:accountid:org:dece:D39621A70BA347A6B098054512DCDE26/User/urn:dece:userid:org:dece:6EB44425B9814DDFB9E7F70C31A184C7
X-transaction-info: [TransactionInfo]

See Also

• UserList()
• UserGet()
• UserUpdate()
• UserDelete()
• PasswordReset()