API Home       Error Codes       API Keys       Showcase       Forum/Discussions

imageloop API function

imagelooop.impersonateAsUser

Impersonate a another user.
Category: special functions
Subcategory: remote registration
Description: Returns an error, if the current API-Key is not allowed to register users. Allows your application to impersonate the current session with a user previously joined or registered with your application. You must specify either the user id or user name. The remoteAuthentication parameter is required.

This function call requires special access privileges. Please ask imageloop for further details to gain these access privileges.

Parameters

Only mandatory parameters must be present for an API call on this function. Parameters marked as a list can occur multiple times in both SOAP and HTTP-RPC style requests.
Name Type Mandatory is List Description
remoteUserId string id of the user in your application
remoteUsername string name of the user in your application
remoteAuthentication string required authentication information

Return Values

The presence of return values depend on the meaning of the API function and status of the requested object. For example, the description value of a looop will not be returned, if it has not been set.
Name Type is List Description
userID uuid ID of the imagelooop user
username string name of the imagelooop user
userpage string user page permalink

Errors / Exceptions

Error Code Name
2001 imagelooop.InvalidApiKeyException
2005 imagelooop.InternalErrorException
2002 imagelooop.InvalidParameterNameException
3004 imagelooop.PermissionDeniedException
3000 imagelooop.PrimaryObjectNotFoundException
3005 imagelooop.InvalidObjectStateException
1001 imagelooop.LoginLockedAccountException

See Also

imagelooop.registerUser

API Call examples

HTTP-RPC

Request:
The line breaks and white spaces are for better reading only. All request parameters can be passed in the HTTP POST request body instead of a HTTP GET parameter in a URL. Valid HTTP POST content types are multipart/form-data for file uploads and application/x-www-form-urlencoded for usual HTML forms.

http://www.imageloop.com/httprpc/?apiKey=YOUR-API-KEY
    &f=imagelooop.impersonateAsUser
    &h=yourwebsite.com  - or -  &accessToken=application-access-token
    &remoteUserId=string-value (optional)
    &remoteUsername=string-value (optional)
    &remoteAuthentication=string-value



Sample response

Sample Response to illustrate what's returned (XML schema) :
The line breaks and white spaces are for better reading only.

<imag:Response xmlns:imag="http://www.imageloop.com/imagelooop-api-xsd/">
   <response name="userID">
      <value>uuiduuid-uuid-uuid-uuid-uuiduuiduuid</value>
   </response>
   <response name="username">
      <value>string-value</value>
   </response>
   <response name="userpage">
      <value>string-value</value>
   </response>
</imag:Response>
If the function call resulted in an error, no response element but an error element is returned in the above XML. See list of possible errors/exception for the function described on this page.
<imag:Response xmlns:imag="http://www.imageloop.com/imagelooop-api-xsd/">
   <error>
      <errorCode>error-code</errorCode>
      <errorType>error-name</errorType>
      <message>optional error message</message>
   </error>
</imag:Response>

SOAP

General overview including SOAP and XML schema types is available here. See http://www.imageloop.com/soap/api/api.wsdl for WSDL definition. http://www.imageloop.com/soap/api/api.xsd for XSD definition.