The restoreAccess utility allows you to restore access to
Marketing Platform if all users with PlatformAdminRole privileges have been inadvertently locked out or if all ability to log in to the
Marketing Platform has been lost.
You might want to use restoreAccess under the two circumstances described in this section.
It is possible that all users with PlatformAdminRole privileges in Marketing Platform might become disabled in the system. Here is an example of how the platform_admin user account might become disabled. Suppose you have only one user with PlatformAdminRole privileges (the platform_admin user). Assume the
Maximum failed login attempts allowed property property in the
General | Password settings category on the Configuration page is set to
3. Then suppose someone who is attempting to log in as platform_admin enters an incorrect password three times in a row. These failed login attempts cause the platform_admin account to become disabled in the system.
In that case, you can use restoreAccess to add a user with PlatformAdminRole privileges to the
Marketing Platform system tables without accessing the web interface.
When you run restoreAccess in this way, the utility creates a user with the login name and password you specify, and with PlatformAdminRole privileges.
If the user login name you specify exists in Marketing Platform as an internal user, that user's password is changed.
If you implement Windows™ Active Directory integration with improper configuration and can no longer log in, use
restoreAccess to restore the ability to log in.
When you run restoreAccess in this way, the utility changes the value of the
Platform | Security | Login method property from
Windows integrated login to
Marketing Platform. This change allows you to log in with any user account that existed before you were locked out. You can optionally specify a new login name and password as well. You must restart the web application server on which
Marketing Platform is deployed if you use the
restoreAccess utility in this way.
When used without the -u loginName option, reset the value of the
Platform | Security | Login method property to
Marketing Platform. Requires restart of the web application server to take effect.
When used with the -u loginName option, create a PlatformAdminRole user.