Operations

• addAuthorizationForUser
• addAuthorizationsForUser
• addUser
• deleteAuthorizationForUser
• deleteAuthorizationsForUser
• disableUser
• enableUser
• getAuthorizationsForUser
• getAuthorizedUsersByAccountID
• getAuthorizedUsersByMasterAccountID
• getAvailableRolesByAccountID
• getCapabilitiesForRole
• getMyAddress
• getMyAuthorizations
• getMyUserInfo
• getUserAddress
• getUserEmail
• getUserInfo
• getUsersInCompany
• getUserStatus
• resetUserPassword
• testUsername
• updateMyAddress
• updateMyEmail
• updateMyPassword
• updateMyUserInfo
• updateUserAddress
• updateUserInfo

addAuthorizationForUser

Grant an authorization for the user (specified by username).

This operation either adds or updates the authorization. If the user does not have an authorization for the specified account, the authorization you specify is added. If the user already has an authorization for the specified account, the authorization you specify updates and replaces that authorization.

Note: You cannot grant a user a role on a master account and one of its associated accounts at the same time. You cannot grant a user more than one role per account (see User Authorization).

Capability required: AccountUserManagementWrite
License command group: Marketing

Parameters

Parameter	Data Type	Description
username	string	The username.
authorization	Authorization	The authorization to grant to the user.

Response

none

addAuthorizationsForUser

Grant one or more authorizations for the user (specified by username).

This operation either adds or updates the authorization. If the user does not have an authorization for the specified account, the authorization you specify is added. If the user already has an authorization for the specified account, the authorization you specify updates and replaces that authorization.

Note: You cannot grant a user a role on a master account and one of its associated accounts at the same time. You cannot grant a user more than one role per account (see User Authorization).

Capability required: MasterAccountUserManagementWrite
License command group: Marketing

Parameters

Parameter	Data Type	Description
username	string	The username.
authorizations	Authorization[]	A list of authorizations to grant to the user.

Response

none

addUser

Create a new user for the company that owns the master account specified in the SOAP header of the request. This user can then be granted authorizations for any master account or account in that company.

Usernames must be unique; before creating a new user, check the username using the testUsername operation.

The system will send the new user an email with instructions on how to login and set his (or her) password. The user, however, cannot perform any operations until he (or she) is granted the appropriate authorizations. To grant authorizations, use the addAuthorizationForUser or addAuthorizationsForUser operations.

Capability required: AccountUserManagementWrite
License command group: Marketing

Parameters

Parameter	Data Type	Description
username	string	The login name for the new user.
userInfo	User	The user profile information.
address	Address	The user address information.

Response

none

deleteAuthorizationForUser

Revoke an authorization for the user (specified by username).

Capability required: AccountUserManagementWrite
License command group: Marketing

Parameters

Parameter	Data Type	Description
username	string	The username.
authorization	Authorization	The authorization to revoke.

Response

none

deleteAuthorizationsForUser

Revoke one or more authorizations for the user (specified by username).

Capability required: MasterAccountUserManagementWrite
License command group: Marketing

Parameters

Parameter	Data Type	Description
username	string	The username.
authorizations	Authorization[]	The list authorizations to revoke.

Response

none

disableUser

Set the status of the user (specified by username) to "Disabled" if it was previously "Active". Once disabled, the user cannot access any of the master accounts and/or accounts he (or she) is authorized to access. Users cannot disable themselves.

Capability required: MasterAccountUserManagementWrite
License command group: Marketing

Parameters

Parameter	Data Type	Description
username	string	The username.

Response

none

enableUser

Set the status of the user (specified by username) to "Active" if it was previously "Disabled". Once enabled, the user can access all of the master accounts and/or accounts he (or she) is authorized to access.

Capability required: MasterAccountUserManagementWrite
License command group: Marketing

Parameters

Parameter	Data Type	Description
username	string	The username.

Response

none

getAuthorizationsForUser

Return the authorizations for the user (specified by username). If the user has been disabled, this operation still returns a list of authorizations for the user.

Capability required: AccountUserManagementRead
License command group: Marketing

Parameters

Parameter	Data Type	Description
username	string	The username.

Response

Authorization[] - A list of authorizations.

getAuthorizedUsersByAccountID

Return the authorized users for the accounts to which you have access (specified by the list of accountIDs). If you do not specify any accounts (empty list), the operation returns the authorized users for all accounts to which you have access for the master account specified in the SOAP header of the request.

Capability required: AccountUserManagementRead
License command group: Marketing

Parameters

Parameter	Data Type	Description
accountIDs	string[]	A list of account IDs. (For this parameter, you may pass in the null string.)

Response

UserAuthorization[] - A list of authorized users.

getAuthorizedUsersByMasterAccountID

Return the authorized users for the master account specified in the SOAP header of the request.

Capability required: AccountUserManagementRead
License command group: Marketing

Parameters

none

Response

UserAuthorization[] - A list of authorized users.

getAvailableRolesByAccountID

Return the available roles for the given account type and the account (specified by account ID).
Your ability to grant roles depends on your own role for the given account.

Capability required: AccountUserManagementRead
License command group: Marketing

Parameters

Parameter	Data Type	Description
accountType	AccountType	The type of account.
accountID	string	The account ID.

Response

Role[] - A list of roles that you can grant.

getCapabilitiesForRole

Return the capabilities for the given role.

Capability required: AccountUserManagementRead
License command group: Marketing

Parameters

Parameter	Data Type	Description
role	Role	The user role.

Response

Capability[] - A list of capabilities.

getMyAddress

Return your address.

Capability required: Selfcare
License command group: Marketing

Parameters

none

Response

Address - Your address information.

getMyAuthorizations

Return the authorizations for all of the master accounts or accounts to which you have access.

Capability required: Selfcare
License command group: Marketing

Parameters

none

Response

Authorization[] - A list of your authorizations.

getMyUserInfo

Return your profile.

Capability required: Selfcare
License command group: Marketing

Parameters

none

Response

User - Your profile information.

getUserAddress

Return the address for the user (specified by username).

Capability required: AccountUserManagementRead
License command group: Marketing

Parameters

Parameter	Data Type	Description
username	string	The username.

Response

Address - The user's address.

getUserEmail

Return the email address for the user (specified by username).

Capability required: AccountUserManagementRead
License command group: Marketing

Parameters

Parameter	Data Type	Description
username	string	The username.

Response

string - The user's email address.

getUserInfo

Return the profile for the user (specified by username).

Capability required: AccountUserManagementRead
License command group: Marketing

Parameters

Parameter	Data Type	Description
username	string	The username.

Response

User - The user's profile.

getUsersInCompany

Return all of the users associated with your company (the level above the master account).

Capability required: AccountUserManagementRead
License command group: Marketing

Parameters

none

Response

string[] - A list of user names.

getUserStatus

Return the status for the user (specified by username).

Capability required: AccountUserManagementRead
License command group: Marketing

Parameters

Parameter	Data Type	Description
username	string	The username.

Response

UserStatus - The user's status.

resetUserPassword

Force a password reset for the user (specified by username). The system will send a "change password" email to the email address contained in the user's profile. The email includes a link to a page that allows the user to change his (or her) password. The link expires in 24 hours.

Capability required: AccountUserManagementWrite
License command group: Marketing

Parameters

Parameter	Data Type	Description
username	string	The username.

Response

none

testUsername

Check if the given username is available.

Capability required: AccountUserManagementRead
License command group: Marketing

Parameters

Parameter	Data Type	Description
username	string	The username to check.

Response

boolean - An indication whether the user name is available.

updateMyAddress

Update your address.

Capability required: Selfcare
License command group: Marketing

Parameters

Parameter	Data Type	Description
address	Address	Your address.
updateAll	boolean	If True, the system performs a full update. All elements are updated. If you pass in the null value or omit an element, the current value is cleared. If False, the system performs a partial update. Only those elements you specify are updated. If you pass in the null value or omit an element, the current value is not changed.

Response

none

updateMyEmail

Update your email address.

Capability required: Selfcare
License command group: Marketing

Parameters

Parameter	Data Type	Description
email	string	Your email address, in standard name@domain.ext format.

Response

none

updateMyPassword

Update your password. (Include your old password in the SOAP header of the request.)

Capability required: Selfcare
License command group: Marketing

Parameters

Parameter	Data Type	Description
newPassword	string	Your new password.

Response

none

updateMyUserInfo

Update your profile.

Capability required: Selfcare
License command group: Marketing

Parameters

Parameter	Data Type	Description
userInfo	User	Your profile.
updateAll	boolean	If True, the system performs a full update. All elements are updated. If you pass in the null value or omit an element, the current value is cleared. If False, the system performs a partial update. Only those elements you specify are updated. If you pass in the null value or omit an element, the current value is not changed.

Response

none

updateUserAddress

Update the address for the user (specified by username).

Capability required: AccountUserManagementWrite
License command group: Marketing

Parameters

Parameter	Data Type	Description
username	string	The username.
address	Address	The address.
updateAll	boolean	If True, the system performs a full update. All elements are updated. If you pass in the null value or omit an element, the current value is cleared. If False, the system performs a partial update. Only those elements you specify are updated. If you pass in the null value or omit an element, the current value is not changed.

Response

none

updateUserInfo

Update the profile for the user (specified by username).

Note: You cannot update a user's email address; users must update their own email. This element is required for a full update; however, the value you supply will be ignored.

Capability required: AccountUserManagementWrite
License command group: Marketing

Parameters

Parameter	Data Type	Description
username	string	The username.
userInfo	User	The user profile.
updateAll	boolean	If True, the system performs a full update. All elements are updated. If you pass in the null value or omit an element, the current value is cleared. If False, the system performs a partial update. Only those elements you specify are updated. If you pass in the null value or omit an element, the current value is not changed.

Response

none