User Data Object - Customer Management

Defines a user.

Multiple user objects can be assigned to the same person i.e., one user per person per customer. The Name, Lcid, JobTitle, and ContactInfo user settings for the same person will be automatically synchronized with any updates that occur after user consolidation. The LastModifiedByUserId and LastModifiedTime are also in sync across each returned User object, unless you had an old username merged and have not updated any user settings since the consolidation.

Note

The TimeStamp differs from the LastModifiedTime. All TimeStamp values are unique per User and when you call UpdateUser you must include the corresponding user's timestamps (including the address timestamp).

For more information see Multi-User Credentials.

Syntax

<xs:complexType name="User" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:sequence>
    <xs:element minOccurs="0" name="ContactInfo" nillable="true" type="tns:ContactInfo" />
    <xs:element minOccurs="0" name="CustomerId" nillable="true" type="xs:long" />
    <xs:element minOccurs="0" name="Id" nillable="true" type="xs:long" />
    <xs:element minOccurs="0" name="JobTitle" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="LastModifiedByUserId" nillable="true" type="xs:long" />
    <xs:element minOccurs="0" name="LastModifiedTime" nillable="true" type="xs:dateTime" />
    <xs:element minOccurs="0" name="Lcid" nillable="true" type="tns:LCID" />
    <xs:element minOccurs="0" name="Name" nillable="true" type="tns:PersonName" />
    <xs:element minOccurs="0" name="Password" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="SecretAnswer" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="SecretQuestion" type="tns:SecretQuestion" />
    <xs:element minOccurs="0" name="UserLifeCycleStatus" nillable="true" type="tns:UserLifeCycleStatus" />
    <xs:element minOccurs="0" name="TimeStamp" nillable="true" type="xs:base64Binary" />
    <xs:element minOccurs="0" name="UserName" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="ForwardCompatibilityMap" nillable="true" type="q4:ArrayOfKeyValuePairOfstringstring" xmlns:q4="http://schemas.datacontract.org/2004/07/System.Collections.Generic" />
  </xs:sequence>
</xs:complexType>

Elements

Element Description Data Type
ContactInfo The user's contact information.

Update: Optional. If no value is specified on update, this Bing Ads setting is not changed.
ContactInfo
CustomerId The identifier of the customer for this user to access.

Update: Read-only
long
ForwardCompatibilityMap The list of key and value strings for forward compatibility to avoid otherwise breaking changes when new elements are added in the current API version.

Forward compatibility changes will be noted here in future releases. There are currently no forward compatibility changes for this object.
KeyValuePairOfstringstring array
Id The Bing Ads identifier of the user.

Update: Required
long
JobTitle The user's job title. The title can contain a maximum of 50 characters.

Update: Optional. If no value is specified on update, this Bing Ads setting is not changed.
string
LastModifiedByUserId The identifier of the last user to update the user's information.

Update: Read-only
long
LastModifiedTime The date and time that that the user information was last updated. The value is in Coordinated Universal Time (UTC).

The date and time value reflects the date and time at the server, not the client. For information about the format of the date and time, see the dateTime entry in Primitive XML Data Types.

Update: Read-only
dateTime
Lcid The locale to use when sending correspondence to the user by email or postal mail. The default is EnglishUS.

Update: Optional. If no value is specified on update, this Bing Ads setting is not changed.
LCID
Name The name of the user.

Update: Optional. If no value is specified on update, this Bing Ads setting is not changed.
PersonName
Password The user's Bing Ads managed sign-in password.

The GetUser operation does not return the password.

Update: Read-only
string
SecretAnswer The answer to the secret question that is specified in the SecretQuestion element. The answer must contain a minimum of five characters and a maximum of 64 characters.

Update: Optional. If no value is specified on update, this Bing Ads setting is not changed.
string
SecretQuestion A question from a list of predefined questions that the user selects to use as his or her secret question. The SecretAnswer element contains the user's answer to the question. The secret question and answer are used to validate the user in case the user forgets his or her password, and requests it.

Update: Optional. If no value is specified on update, this Bing Ads setting is not changed.
SecretQuestion
TimeStamp A time-stamp value that the system uses internally to reconcile updates when you call UpdateUser or DeleteUser.

Update: Required
base64Binary
UserLifeCycleStatus The status of the user.

Update: Read-only
UserLifeCycleStatus
UserName The logon user name of the user.

Starting with Bing Ads API version 12, only OAuth authentication will be supported. You will need to migrate to an email address user name.

The email address of the Microsoft Account may differ from the Email element of the ContactInfo object.

Update: Read-only
string

Requirements

Service: CustomerManagementService.svc v12
Namespace: https://bingads.microsoft.com/Customer/v12/Entities

Used By

GetUser
UpdateUser