Export (0) Print
Expand All

UpdateUserRoles Service Operation

Updates the roles of the specified user.

Request | Response

Error Codes | Remarks

Service: CustomerManagementService.svc v9 | Namespace: https://bingads.microsoft.com/Customer/v9

UpdateUserRolesRequest Message

Request Body

The UpdateUserRolesRequest object defines the elements of the request’s body. The elements must be in the same order as shown in the SOAP example.

Element

Description

Data Type

CustomerId

The identifier of the customer to which the user belongs.

long

DeleteAccounts

An array of identifiers of the accounts to remove from the list of accounts that the user can manage.

For usage, see the remarks section below.

long array

DeleteCustomers

An array of identifiers of the customers to remove from the list of customers that the user can manage.

For usage, see the remarks section below.

long array

DeleteRoleId

The identifier of the role to which the values specified in the DeleteAccounts or DeleteCustomers element applies, if set.

For more information about possible role values, see the corresponding Integer Value column within the UserRole value set.

int

NewAccounts

An array of identifiers of the accounts to restrict the user to. The user will be able to manage only these accounts.

If the user is currently restricted to a set of accounts, set this element to the new accounts that you want the user to also manage. For example, if the user currently manages accounts 123 and 456, and you want the user to also manage account 789, set this element to 789.

For usage, see the remarks section below.

long array

NewCustomers

An array of identifiers of the customers to restrict the user to. The user will be able to manage only these customers.

For usage, see the remarks section below.

long array

NewRoleId

The identifier of the role to which the values specified in the NewAccounts or NewCustomers element applies to, if set.

For more information about possible role values, see the corresponding Integer Value column within the UserRole value set.

int

UserId

The identifier of the user whose role you want to update.

long

Request Header

For information about the values you set the DeveloperToken, Password, and UserName elements to, see Getting Started With the Bing Ads API.

Element

Description

Data Type

ApplicationToken

The application-access token. This header element is not used and should be null.

string

AuthenticationToken

The OAuth access token used to manage Bing Ads accounts linked to a Microsoft Account. For more information, see Managing User Authentication with OAuth.

string

DeveloperToken

The client application's developer access token.

string

Password

The Bing Ads user's sign-in password.

string

UserName

The Bing Ads user's sign-in user name. You may not set this element to a Microsoft account.

string

Request SOAP

The following example shows the complete request envelope.

<s:Envelope xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header xmlns="https://bingads.microsoft.com/Customer/v9">
    <Action mustUnderstand="1">UpdateUserRoles</Action>
    <ApplicationToken i:nil="false"></ApplicationToken>
    <AuthenticationToken i:nil="false"></AuthenticationToken>
    <DeveloperToken i:nil="false"></DeveloperToken>
    <Password i:nil="false"></Password>
    <UserName i:nil="false"></UserName>
  </s:Header>
  <s:Body>
    <UpdateUserRolesRequest xmlns="https://bingads.microsoft.com/Customer/v9">
      <CustomerId></CustomerId>
      <UserId></UserId>
      <NewRoleId i:nil="false"></NewRoleId>
      <NewAccountIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <a1:long></a1:long>
      </NewAccountIds>
      <NewCustomerIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <a1:long></a1:long>
      </NewCustomerIds>
      <DeleteRoleId i:nil="false"></DeleteRoleId>
      <DeleteAccountIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <a1:long></a1:long>
      </DeleteAccountIds>
      <DeleteCustomerIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <a1:long></a1:long>
      </DeleteCustomerIds>
    </UpdateUserRolesRequest>
  </s:Body>
</s:Envelope>

UpdateUserRolesResponse Message

Response Body

The response does not contain additional body elements.

Response Header

Element

Description

Data Type

TrackingId

The identifier of the log entry that contains the details of the API call.

string

Response SOAP

The following example shows the complete response envelope.

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header xmlns="https://bingads.microsoft.com/Customer/v9">
    <TrackingId p4:nil="false" xmlns:p4="http://www.w3.org/2001/XMLSchema-instance"></TrackingId>
  </s:Header>
  <s:Body>
    <UpdateUserRolesResponse xmlns="https://bingads.microsoft.com/Customer/v9">
      <LastModifiedTime></LastModifiedTime>
    </UpdateUserRolesResponse>
  </s:Body>
</s:Envelope>

Error Codes

If the service operation fails, it throws a FaultException exception, which contains one or more of the Bing Ads API error data objects. For information about the fault detail objects, see Customer Management Error Data Objects and Handling Service Errors and Exceptions.

The following are example error codes that the error objects can include when using this service operation. For all documented error codes, please see Bing Ads Operation Error Codes.

Error Code

InvalidCredentials

As an example use case if an advertiser campaign manager is limited to managing accounts 123, 456, and 789, and you no longer want the user to manage 456, set the following elements accordingly:

  • Set the NewRoleId element to 16 (advertiser campaign manager role).

  • Set the NewAccounts element to an array that contains 123 and 789.

  • Set the DeleteRoleId element to 16 (advertiser campaign manager role).

  • Set the DeleteAccounts element to an array that contains 456.

If an advertiser campaign manager is limited to managing accounts 123 and 789, and you now want the user to manage all accounts, set the following elements accordingly:

  • Set the NewRoleId element to 16 (advertiser campaign manager role).

  • Set the NewAccounts element to NULL.

  • Set the DeleteRoleId element to 16 (advertiser campaign manager role).

  • Set the DeleteAccounts element to an array that contains 123, 456, and 789.

Users with account level roles can be restricted to specific accounts. Users with customer level roles can access all accounts within the user’s customer, and their access cannot be restricted to specific accounts.

System_CLiX_note Note

When attempting to restrict customer level user roles to specific accounts the UpdateUserRoles operation will not fail, and the user will retain access for all accounts within the user’s customer.

Community Additions

ADD
Show:
© 2014 Microsoft