Package com.atlassian.jira.rest.v2.user.anonymization

Class UserAnonymizationResource

java.lang.Object

com.atlassian.jira.rest.v2.user.anonymization.UserAnonymizationResource

@Path("user/anonymization")
@Consumes("application/json")
@Produces("application/json")
public class UserAnonymizationResource
extends Object

Since:

v8.4

Field Summary

Fields

Modifier and Type	Field	Description
static final String	EXPAND_AFFECTED_ENTITIES

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	getProgress(long taskId)	Returns information about a user anonymization operation progress.
javax.ws.rs.core.Response	scheduleUserAnonymization(UserAnonymizationRequestBean userAnonymizationRequestBean)	Schedules a user anonymization process.
javax.ws.rs.core.Response	scheduleUserAnonymizationRerun(UserAnonymizationRerunRequestBean userAnonymizationRequestBean)	Schedules a user anonymization process.
javax.ws.rs.core.Response	unlockAnonymization()	Removes stale user anonymization task, for scenarios when the node that was executing it is no longer alive.
javax.ws.rs.core.Response	validateUserAnonymization(String userKey, String expand)	Validates user anonymization process.
javax.ws.rs.core.Response	validateUserAnonymizationRerun(String userKey, String oldUserKey, String oldUserName, String expand)	Validates user anonymization re-run process.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

EXPAND_AFFECTED_ENTITIES

public static final String EXPAND_AFFECTED_ENTITIES

See Also:

• Constant Field Values

Method Details

validateUserAnonymization

@GET
public javax.ws.rs.core.Response validateUserAnonymization(@QueryParam("userKey")
 String userKey,
 @QueryParam("expand")
 String expand)

Validates user anonymization process.

Parameters:

userKey - the key of the user to validate anonymization for.

expand - Parameter used to include parts of the response. This can be used to include: affectedEntities. Affected entities will only be returned if expand=affectedEntities.

validateUserAnonymizationRerun

@Path("/rerun")
@GET
public javax.ws.rs.core.Response validateUserAnonymizationRerun(@QueryParam("userKey")
 String userKey,
 @QueryParam("oldUserKey")
 String oldUserKey,
 @QueryParam("oldUserName")
 String oldUserName,
 @QueryParam("expand")
 String expand)

Validates user anonymization re-run process.

Parameters:

userKey - the key of the user to validate anonymization for

oldUserKey - user key before anonymization, only needed when current value is anonymized. If there is no old key, e.g. because the user was already created using the new key generation strategy, provide a value equal to the current key.

oldUserName - user name before anonymization, only needed when the current value is anonymized. If there is no old name, provide a value equal to the current name.

expand - Parameter used to include parts of the response. This can be used to include: affectedEntities. Affected entities will only be returned if expand=affectedEntities.

scheduleUserAnonymization

@POST
public javax.ws.rs.core.Response scheduleUserAnonymization(UserAnonymizationRequestBean userAnonymizationRequestBean)
                                                    throws URISyntaxException

Schedules a user anonymization process. Requires system admin permission.

Parameters:

userAnonymizationRequestBean - JSON containing parameters to schedule the anonymization process with

Throws:

URISyntaxException

scheduleUserAnonymizationRerun

@Path("/rerun")
@POST
public javax.ws.rs.core.Response scheduleUserAnonymizationRerun(UserAnonymizationRerunRequestBean userAnonymizationRequestBean)
                                                         throws URISyntaxException

Schedules a user anonymization process. Requires system admin permission.

Parameters:

userAnonymizationRequestBean - JSON containing parameters to schedule the anonymization process with

Throws:

URISyntaxException

getProgress

@GET
@Path("progress")
public javax.ws.rs.core.Response getProgress(@QueryParam("taskId")
 long taskId)
                                      throws URISyntaxException

Returns information about a user anonymization operation progress.

Parameters:

taskId - the id of a user anonymization task you wish to obtain details on. If omitted, then defaults to the active anonymization task, or the last task that was run if no anonymization is taking place.

Throws:

URISyntaxException

unlockAnonymization

@DELETE
@Path("unlock")
public javax.ws.rs.core.Response unlockAnonymization()

Removes stale user anonymization task, for scenarios when the node that was executing it is no longer alive.