getUserInfo

Gets information about a user. Use the email address and the password of a system user as credentials for authorizing the request. Otherwise, the operation gets information about the default user.

Syntax

Authorized User Types

IpsUser
IpsAdmin
IpsCompanyAdmin
TrialSiteAdmin
TrialSiteUser
ImagePortalAdmin
ImagePortalUser
ImagePortalContrib
ImagePortalContribUser

Parameters

Input (getUserInfoParam)

Name	Type	Required	Description
userHandle	`xsd:string`	No	Handle to the user whose information you want to return.
email	`xsd:string`	No	User email address.

Output (getUserInfoReturn)

Name	Type	Required	Description
userInfo	`types:User`	Yes	The first name, last name, email address, and role of a user, as well as whether the user is valid and when the user’s password expires.

Examples

This code sample returns information for the default IPS user.

Request

<getUserInfoParam xmlns="http://www.scene7.com/IpsApi/xsd" /></getUserInfoParam>

Response

<ns1:getUserInfoReturn xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
   <ns1:userInfo>
      <ns1:userHandle>3261|user@scene7.com</ns1:userHandle>
      <ns1:firstName>FirstName</ns1:firstName>
      <ns1:lastName>LastName</ns1:lastName>
      <ns1:email>user@scene7.com</ns1:email>
      <ns1:role>IpsAdmin</ns1:role>
      <ns1:isValid>true</ns1:isValid>
      <ns1:passwordExpires>2107-04-22T18:35:41.995Z</ns1:passwordExpires>
   </ns1:userInfo>
</ns1:getUserInfoReturn>