org.labkey.remoteapi.security.ImpersonateUserCommand Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of labkey-client-api Show documentation

The client-side library for Java developers is a separate JAR from the LabKey Server code base. It can be used by any Java program, including another Java web application.

The newest version!

package org.labkey.remoteapi.security;

import org.labkey.remoteapi.CommandResponse;
import org.labkey.remoteapi.PostCommand;

import java.util.HashMap;
import java.util.Map;

/**
 * For site-admins or project-admins only, start impersonating a user.
 * 
 * Admins may impersonate other users to perform actions on their behalf.
 * Site users may impersonate any user in any project. Project admins must
 * execute this command in a project in which they have admin permission
 * and may impersonate any user that has access to the project.
 * 
 * To finish an impersonation session use either {@link LogoutCommand} to
 * log the original user out or use {@link StopImpersonatingCommand} to stop
 * impersonating while keeping the original user logged in.
 */
public class ImpersonateUserCommand extends PostCommand
{
    private final Map _parameters = new HashMap<>();

    public ImpersonateUserCommand(int userId)
    {
        super("user", "impersonateUser.api");
        _parameters.put("userId", userId);
    }

    public ImpersonateUserCommand(String email)
    {
        super("user", "impersonateUser.api");
        _parameters.put("email", email);
    }

    @Override
    protected Map createParameterMap()
    {
        return new HashMap<>(_parameters); // Return a copy
    }
}