UserUpdate()

This API is used to update Ultraviolet user data.

Nodes acting on behalf of standard Users cannot update any user but the one identified in the SAML security token.

A minimum of 1 full access User must be present in an Account at all times; the last remaining full access user cannot be updated, regardless of the access level of the user identified in the SAML security token.

API URL:

[BaseURL]/Account/{AccountID}/User/{UserID}

Request Method:

PUT

Request Parameters:

• AccountID is the unique identifier for an Account
• UserID is the unique identifier for a User

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
  • Languages
    • Language
  • Credentials
    • Username

Optional information:

• /User/Credentials/Password

  If not provided, the User password will not be changed.

Headers:

• Authorization: SAML2 assertion=[Assertion]

Response Format

Status Code:

• HTTP 200 Ok

Errors

• SecurityContextForbidden
  • The request is not authorized
  • HTTP Status Code: 403
• MandatoryFieldCannotBeNullOrEmpty
  • Missing any of the required information
  • HTTP Status Code: 400
• 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
• AccountUsernameRegistered
  • The sign-in name already exists
  • HTTP Status Code: 400 Bad Request
• ParserException
  • Invalid format of the UserID
  • HTTP Status Code: 400
• UserIdInvalid
  • Either of the following:
    • The UserID request parameter is not valid
    • User not found
    • User does not have a permission to perform the update
  • HTTP Status Code: 400 Bad Request
• UserClassUnsupported
  • The @UserClass is not valid
  • HTTP Status Code: 400 Bad Request
• LastFullAccessUserCannotBeDemotedToStandardOrBasicPrivilege
  • The permission level of the last remaining full-access member in an account cannot be changed
  • HTTP Status Code: 403 Forbidden

Example

Update user data

The following example API call updates an existing users email address and username.

Sample Request:

PUT /rest/2015/02/Account/urn:dece:accountid:org:dece:D39621A70BA347A6B098054512DCDE26/User/urn:dece:userid:org:dece:6EB44425B9814DDFB9E7F70C31A184C7 HTTP/1.1
Host: api.uvvu.com
Accept: application/xml
Authorization: SAML2 assertion=[Assertion]

<?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>new@email.com</Value>
    </PrimaryEmail>
  </ContactInfo>
  <Languages>
    <Language>en-US</Language>
  </Languages>
  <Credentials>
    <Username>new@email.com</Username>
  </Credentials>
</User>

Sample Response:

HTTP/1.1 200
Date: [Date]
Content-Type: application/xml
X-transaction-info: [TransactionInfo]

See Also

• UserCreate()
• UserList()
• UserGet()
• UserDelete()
• PasswordReset()