DocumentationDynamic Media Image Production System API

checkLogin

Last update: Tue Mar 08 2022 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Developer
  • Admin

Checks if a user with a specific company (identified by handle), email address, and password can log in.

NOTE
If the company handle is omitted, this method checks the login of the default user.

Authorized User Types

  • IpsUser
  • IpsAdmin
  • IpsCompanyAdmin
  • TrialSiteAdmin
  • TrialSiteUser
  • ImagePortalAdmin
  • ImagePortalUser
  • ImagePortalContrib
  • ImagePortalContribUser

Parameters

Input (checkLoginParam)

Name
Type
Required
Description
companyHandle
xsd:string
No
The handle to the company that contains the user.
email
xsd:string
Yes
The user’s email address.
password
xsd:string
Yes
The user’s password.

Output (checkLoginParam)

Name
Type
Required
Description
status
xsd:string
Yes
User’s log in status.

Examples

This sample code uses a company handle parameter, email address, and a password to determine if a user can log in to IPS. If the user can log in, this method returns the string, ValidLogin. If the user cannot log in, this method returns the string, InvalidLogin.

Request

<ns1:checkLoginParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
   <ns1:companyHandle>137</ns1:companyHandle>
   <ns1:email>juser3@scene7.com</ns1:email>
   <ns1:password>welcome</ns1:password>
</ns1:checkLoginParam>

Response

<ns1:checkLoginReturn xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
   <ns1:status>InvalidLogin</ns1:status>
</ns1:checkLoginReturn>
4e9b9d8c-5839-4215-aa35-01b652869681