Skip to main content
Adaptive Insights
Knowledge and Support - Adaptive Insights

updateUser

Category

Metadata modification

Description

Update a user(s). If successful, the API will return a message for the user that has just been updated.

Permissions Required To Invoke

User Permission

Parameters Required On Request

Credentials

This method's request contains a credentials tag to identify and authorize the calling user. User must have "User Permission" permission to update the user(s).

Request Format

<?xml version='1.0' encoding='UTF-8'?>
<call method="updateUser" callerName="a string that identifies your client application">
       <credentials login="sampleuser@company.com" password="my_pwd" />
         <users>
             <user
               guid="B9ADBCB81AA2F9BAE040307F02092C2E"
               email="updateMail@company.com"
               name="update name"
               password="new Password"
               roleId="1"
               ownedLevels="2,3,7,11"
               timeZone="America/Mexico_City"
                    /> 
        </users>
</call>

 

credentials element

Tag Name

credentials

Description

All API calls must contain a single credentials element to identify the user invoking the API. The API call is then performed as this user (any audit trail or history of actions in the system will show that this user performed the action), and therefore the user must have the required permissions to perform the action in order for the API call to succeed.

Attributes of the Element

Attribute Name

Required?

Value

Example

login

Y

The login name of the user invoking the API method. This user must have a role containing the permissions required for the method being invoked.

sampleuser@company.com

password

Y

The password of the user invoking the API method.

my_password

locale

N

Specify the locale to be used to interpret incoming numbers and dates, and to format outgoing numbers and dates (using the proper thousands separator, month names, and date formatting). The locale is also used to specify the language in which any system messages in the response should appear. If not specified, en_US (American English) is used.

fr_FR

instanceCode

N

If the user specified in the credentials has access to more than one instance of Adaptive Planning, this attribute can be used to specify that the user is intending to access an instance other than their default instance. If not specified, the user's default instance will be used. To determine the available instance codes, use the exportInstances API.

MYINSTANCE1

Contents of the Element

(none)

 

user element

Tag Name

user

Description

Specifies a user or users to update.

Attributes of the Element

Attribute Name

Required?

Value

Example

guid

Y

A globally-unique identifier for the user. This identifier will never change for this user, even if their login or name changes in the future. (The guide is also covered in the exportUsers API)

B9ADB-
CB81AA2F9BAE040307F02092C2E

email

N

The email address for this user. Uniqueness is required. The only allowed characters are a-z, A-Z, 0-9, - and .

newUser@company.com

name

N

The name of this user.

Melvin Morsmere

password

N

The password of this user. If you are updating a user who is in a multi-instance environment you can only specify password changes in their default instance.

newpassword

roleId

N

The internal system ID of the role assigned to this user. (The roleId attribute is also covered in the exportRoles API.)

3

ownedLevels

N

The internal system ID for the levels separated by comma. (The ownedLevels attribute is also covered in the exportLevels API.)

5,10,13

timeZone

N

The time zone of the user.

US/Pacific

Contents of the Element

(none)

Response Format

<?xml version='1.0' encoding='UTF-8'?>
   <response success="true">
      <output>
          <result>
                <updated_users>
                    <user success="true" message="user newUser@company.com was updated successfully."/>
                </updated_users>
          </result>
      </output>
</response>

response element

Tag Name

response

Attributes of the Element

Attribute Name

Required?

Value

Example

success

Y

Either true or false, indicating whether the API call was successful or not. Even successful calls may contain warning messages in their response.

true

Contents of the Element

A single result element with created_user or updated_user status elements depending on whether a createUser or updateUser call was made, respectively.

 

result element

Tag Name

result

Description

Container for one or more status elements.

Attributes of the Element

Attribute Name

Required?

Value

Example

(none)

Contents of the Element

One or more created_user or updated_user status elements depending on whether a createUser or updateUser call was made, respectively.

 

updated_users element

Tag Name

updated_users

Description

Represents a message sent from the system back to the caller.

Attributes of the Element

Attribute Name

Required?

Value

Example

user success

Y

The status returned by the call. Can be true or false.

true

message

Y

The status message.

user newuser@company.com
was updated successfully.

Contents of the Element

One subscriptions element.

  • Was this article helpful?