ARSetImpersonatedUser

Important

You can continue to use C APIs to customize your application, but C APIs are not enhanced to support new capabilities provided by Java APIs and REST APIs.

Description

Enables plug-ins, the Mid Tier, and other programs (such as Email Engine) to run as an administrator but to perform operations as a specific user (with the user's permissions and licensing in effect). For more information, see Impersonating-a-user.

If you perform a set operation on an overlay and you provide values for an inherited grain, the values are ignored. Only values for extended or overwritten grains of the overlay are set.

Privileges

AR System administrator.

Synopsis

#include "ar.h"
#include "arerrno.h"
#include "arextern.h"
#include "arstruct.h"

int ARSetImpersonatedUser(
  ARControlStruct *control,
  ARAccessNameType impersonatedUser,
  ARStatusList *status)

control

The control record for the operation. It contains information about the user requesting the operation, where that operation is to be performed, and which session is used to perform it. The user and server fields are required.

impersonatedUser

The name of the user that the API is impersonating.

Specify NULL if you want to stop impersonating.

Return values

status

A list of zero or more notes, warnings, or errors generated from a call to this function. For a description of all possible values, see Error-checking.