Developer Network Home - Help

UserManagementService

UserManagementService provides operations for user, authorization, and payment method management.

Operations that include the word "my" can be executed by any user but only to add, get, or update their own user information. User name and password are included in the SOAP header for the request.

Operations that include the word "user" can be executed by an administrator for another user but only if the administrator has access to that user's information based on the admin's role and the account.

For more information about UserManagementService, see UserManagementService in the Getting Started Guide.

The WSDL for this service is located at UserManagementService.wsdl.

Operations

addUser

Create a new user record and associate that user with this master account. The new user will get an email with instructions on how to login and set their password. If the username you try in this operation already exists, the operation will be rejected. Use testUsername to try a user name before creating a new user. The new user does not have a default role in the system (and therefore no access). Grant authorizations to this user with addAuthorizationsForUser.

Capability required: AccountUserManagementWrite
License command group: Marketing

Parameters

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

Response

none

addAuthorizationsForUser

Grant the specified authorizations for the master account or account to a user. An authorization is an association between a role and an account.

Capability required: AccountUserManagementWrite
License command group: Marketing

Parameters

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

Response

none

getAvailableRolesByAccountID

Return the available roles that you are able to grant for the given account type and the given account ID. Your ability to grant roles is dependent 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 (master account or account).
accountID long The account ID.

Response

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

testUsername

Check if the given username is available in the system.

Capability required: AccountUserManagementRead
License command group: Marketing

Parameters

Parameter Data Type Description
username String The user name to test.

Response

boolean - An indication whether the name is available.

getMyUserInfo

Return your user profile information.

Capability required: Selfcare
License command group: Marketing

Parameters

none

Response

User - The user profile (name, email, phone numbers, and so on).

getMyAddress

Return your address information.

Capability required: Selfcare
License command group: Marketing

Parameters

none

Response

Address - The address information or null if no Address on file.

updateMyUserInfo

Update your user profile. To update your email address, use updateMyEmail.

Capability required: Selfcare
License command group: Marketing

Parameters

Parameter Data Type Description
userInfo User The user information. All elements are optional.

Response

none

updateMyAddress

Update your address information.

Capability required: Selfcare
License command group: Marketing

Parameters

Parameter Data Type Description
address Address The address information. All elements are optional.

Response

none

updateMyEmail

Update your email address.

Capability required: Selfcare
License command group: Marketing

Parameters

Parameter Data Type Description
email String The email address, in standard name@domain.ext format.

Response

none

getMyAuthorizations

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

Capability required: Selfcare
License command group: Marketing

Parameters

none

Response

Authorization[] - A list of authorizations. An authorization is an association with an account and a role. From the authorization you can find the account ID, type, and role.

updateUserInfo

Update the profile for a specific user. You must have access to user management capabilities to perform this operation. Note that you cannot update a user's email address; users must update their own email.

Capability required: AccountUserManagementWrite
License command group: Marketing

Parameters

Parameter Data Type Description
username String The name of the user.
userInfo User The new user profile.

Response

none

updateUserAddress

Update the address for a specific user. You must have access to user management capabilities to perform this operation.

Capability required: AccountUserManagementWrite
License command group: Marketing

Parameters

Parameter Data Type Description
username String The name of the user.
address Address The new address.

Response

none

getUserInfo

Return the user profile for a specific user. You must have access to user management capabilities to perform this operation.

Capability required: AccountUserManagementRead
License command group: Marketing

Parameters

Parameter Data Type Description
username String The name of the user.

Response

User - The user profile.

getUserAddress

Return the address for a specific user. You must have access to user management capabilities to perform this operation.

Capability required: AccountUserManagementRead
License command group: Marketing

Parameters

Parameter Data Type Description
username String The name of the user.

Response

Address - The user's address.

getUserEmail

Return the email address for a specific user. You must have access to user management capabilities to perform this operation.

Capability required: AccountUserManagementRead
License command group: Marketing

Parameters

Parameter Data Type Description
username String The name of the user.

Response

String - The user's email address.

getUserStatus

Return the status for a specific user. You must have access to user management capabilities to perform this operation.

Capability required: AccountUserManagementRead
License command group: Marketing

Parameters

Parameter Data Type Description
username String The name of the user.

Response

UserStatus - The user's status.

getAuthorizationsForUser

Return the list of authorizations for a specific user. An authorization is an association between a role and a master account or an account. You must have access to user management capabilities to perform this operation. Note that a user with the AccountAdministrator role has implicit access to all the child accounts under a master account, so an explicit role is not assigned for each account.

Capability required: AccountUserManagementRead
License command group: Marketing

Parameters

Parameter Data Type Description
username String The name of the user.

Response

Authorization[] - A list of authorizations. An authorization is an association with an account and a role. From the authorization you can find the account ID, type, and role.

getUsersInCompany

Return all the users associated with your company (the level above the master account). You must have access to user management capabilities to perform this operation.

Capability required: AccountUserManagementRead
License command group: Marketing

Parameters

none

Response

String[] - A list of user names.

getAuthorizedUsersByMasterAccountID

Return a list of UserAuthorization elements for the current master account. You must have access to user management capabilities to perform this operation. A UserAuthorization is an association between a user, role, and an account, and defines the access that user has to that account.

Capability required: AccountUserManagementRead
License command group: Marketing

Parameters

none

Response

UserAuthorization[] - A list of UserAuthorization elements. A UserAuthorization is an association between a user, role, and an account. From the UserAuthorization you can find the specific user, account ID, and role.

getAuthorizedUsersByAccountID

Return a list of UserAuthorization elements for the given account. You must have access to user management capabilities to perform this operation. A UserAuthorization is an association between a user, role, and an account, and defines the access that user has to that account. If accountIDs is not specified, this operation returns the UserAuthorization elements for all accounts this user has access to.

Capability required: AccountUserManagementRead
License command group: Marketing

Parameters

Parameter Data Type Description
accountIDs[] long[] A list of account IDs.

Response

UserAuthorization[] - A list of UserAuthorization elements. A UserAuthorization is an association between a user, role, and an account. From the UserAuthorization you can find the specific user, account ID, and role.

deleteAuthorizationsForUser

Revoke authorizations for a given user. You must have access to user management capabilities to perform this operation. The authorization defines the association between a role and an account. If no authorizations are specified, all roles for the given user for the current master account and all child accounts are revoked.

Capability required: AccountUserManagementWrite
License command group: Marketing

Parameters

Parameter Data Type Description
username String The name of the user.
authorizations[] Authorization[] A list authorizations to revoke; if null, will revoke all authorizations for this user for the current master account and all child accounts.

Response

none

deleteUser

Delete the given user. You must have administrator access to the master account the user was originally created for to perform this operation.

Capability required: UserManagementDelete
License command group: Marketing

Parameters

Parameter Data Type Description
username String The name of the user.

Response

none

deleteUsers

Delete a list of users. You must have administrator access to the master account all the users were originally created for to perform this operation.

Capability required: UserManagementDelete
License command group: Marketing

Parameters

Parameter Data Type Description
usernames[] String[] A list of user names.

Response

none

updateMyPassword

Update your password. The old password is passed in through the SOAP header.

Capability required: Selfcare
License command group: Marketing

Parameters

Parameter Data Type Description
newPassword String The new password.

Response

none

resetUserPassword

Force a password reset for another user. You must have access to user management capabilities to perform this operation. Note that you cannot directly change the password for another user; this operation triggers a change password email to be sent to the user at the email address contained in their user profile.

Capability required: AccountUserManagementWrite
License command group: Marketing

Parameters

Parameter Data Type Description
username String The name of the user.

Response

none

getCapabilitiesForRole

Returns the capabilities for the specified Role. Roles define user roles such as AccountAdministrator; capabilities define the kinds of operations that role can perform and thus the amount of access the user has to the system.

Capability required: AccountUserManagementRead
License command group: Marketing

Parameters

Parameter Data Type Description
role Role The user Role.

Response

Capability[] - A list of capabilities.

addCreditCard

Add credit card and billing information for the current master account.

Capability required: AccountUserManagementWrite
License command group: Marketing

Parameters

Parameter Data Type Description
billingUserInfo User The billing user contact information.
billingAddress Address The billing address information.
cc CreditCardInfo The credit card information.

Response

long - The unique identifier for this payment method in the system.

updateCreditCard

Update billing or credit card information for the master account.

Capability required: AccountUserManagementWrite
License command group: Marketing

Parameters

Parameter Data Type Description
id long The unique identifier for this payment method in the system. You can get this ID with the getPaymentMethods operation.
billingUserInfo User The billing user contact information.
billingAddress Address The billing address information.
cc CreditCardInfo The credit card information. Note that the cardNumber and cardType elements of CreditCardInfo cannot be updated; to add a new card use addCreditCard instead.

Response

none

getPaymentMethods

Return the payment methods for the master account.

Capability required: AccountUserManagementRead
License command group: Marketing

Parameters

none

Response

PaymentMethodInfo[] - A list of PaymentMethodInfo elements. From the PaymentMethodInfo you can get payment method identifiers, the last four digits of the credit card number, and its expiration date.

Copyright © 2006 Yahoo! Inc. All rights reserved.

Privacy Policy - Terms of Service - Copyright Policy - Job Openings