|
|
Getting Started Guide: UserManagementService Overview
UserManagementService provides operations for user authentication, data, and authorization management.
About User Management
Users are associated with companies and are granted authorizations for master accounts, accounts, campaigns, and so on. User information is managed by master account administrators and account managers as well as by the users themselves.
Administrators and Managers
To add, get, or update user information for another user, use the operations that include the word "User" or which belong to the MasterAccountUserManagementWrite or AccountUserManagementWrite capabilities. You must have an administrator or manager role for the master account or for the account to which the user belongs.
Users
To add, get, or update your own user information, use the operations that include the word "My" or which belong to the Selfcare capability.
Operations
The UserManagementService operations are shown here, organized loosely by type:
Operation Type |
Administrators and Managers |
Users |
|---|---|---|
| User Authentication |
addUser disableUser enableUser getUserStatus getUsersInCompany testUsername resetUserPassword |
updateMyPassword |
| User Information |
getUserInfo updateUserInfo getUserAddress getUserEmail |
getMyUserInfo updateMyUserInfo getMyAddress updateMyAddress updateMyEmail |
| User Authorization |
addAuthorizationForUser addAuthorizationsForUser deleteAuthorizationForUser deleteAuthorizationsForUser getAuthorizationsForUser getAuthorizedUsersByAcccountID getAuthorizedUsersByMasterAccountID getAvailableRolesByAccountID getCapabilitiesForRole |
getMyAuthorizations |
User Authentication
Users belong to companies. Companies are added to the system when customers enroll with Yahoo! Search Marketing. See Enrollment. To determine the users in a company, use the getUsersInCompany operation.
To add a new user, administrators and managers should use the addUser operation. The username that you specify must be unique; use the testUsername operation to check if the username is available. If the operation is successful, the system will send the user an email with instructions on how to login and set the password.
To enable or disable a user, administrators and managers should use the enableUser or disableUser operations.
Note: Unlike the web application, when you disable a user via EWS, you prevent the user from accessing any and all master accounts and accounts the user previously had access to.
Both operations will change the status of the user. To check the status of a user, use the getUserStatus operation.
To request a password change for another user, use the resetUserPassword operation. Because administrators and managers cannot directly change the password of another user, the resetUserPassword operation will send the user an email that informs the user how to change the password. To update your own password, use the updateMyPassword operation.
User Information
Information about a user includes the user's general information, which is managed through the UserManagementService, and the user's billing information, which is managed through the VaultService.
General information includes the user's profile, address, and email address. To review or update this information for another user, use the corresponding "User" operations. To review or update your own information, use the corresponding "My" operations.
User Authorization
A user authorization is an association between a user, a role, and an account and, together with the provisions of your EWS license, determine which operations a user can perform. See Roles and Capabilities.
Authorizations
To add, delete, or review authorizations for another user, use the corresponding "User" operations. To review your own authorizations, use the getMyAuthorizations operation.
For the addAuthorizationForUser and addAuthorizationsForUser operations, note the following. 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. For example:
- You can grant a user the role of MasterAccountAdministrator for the master account. Or, under the master account, you can grant a user the roles of AccountManager for Account-A and AccountManager for Account-B.
- However, you cannot grant a user the roles of MasterAccountAdministrator for the master account and AccountManager for Account-A. If you do, the AccountManager role will override the MasterAccountAdministrator role.
- Also, you cannot grant a user the roles of AccountManager for Account-A and CampaignManager for Account-A. If you do, the CampaignManager role will override the AccountManager role.
To determine user authorizations for a specific master account or account, use the getAuthorizedUsersByMasterAccountID and getAuthorizedUsersByAcccountID operations.
Roles and Capabilities
To determine the roles for a specific account or the capabilities for a specific role, use the getAvailableRolesByAccountID and getCapabilitiesForRole operations.