DocumentatieDynamic Media Image Production System-API

checkLogin checklogin

Last update: Fri Aug 15 2025 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Onderwerpen:

Gemaakt voor:

  • Ontwikkelaar
  • Beheerder

Controleert of een gebruiker met een specifiek bedrijf (geïdentificeerd door greep), e-mailadres, en wachtwoord zich kan aanmelden.

NOTE
Als het bedrijfshandvat wordt weggelaten, controleert deze methode login van de standaardgebruiker.

Geautoriseerde gebruikerstypen section-df8b26b550854f899948276adaca083a

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

Parameters section-1ad4c0b4803b4388aedd655030676cb3

Input (checkLoginParam)

Naam
Type
Vereist
Beschrijving
companyHandle
xsd:string
Nee
De handgreep aan het bedrijf dat de gebruiker bevat.
email
xsd:string
Ja
Het e-mailadres van de gebruiker
password
xsd:string
Ja
Het wachtwoord van de gebruiker.

Output (checkLoginParam)

Naam
Type
Vereist
Beschrijving
status
xsd:string
Ja
Aanmeldingsstatus van gebruiker.

Voorbeelden section-23f90100a9d94bc7b4045634cccd1b98

Deze steekproefcode gebruikt een parameter van het bedrijfshandvat, e-mailadres, en een wachtwoord om te bepalen als een gebruiker aan IPS kan login. Als de gebruiker ** login kan, keert deze methode het koord terug, ValidLogin. Als de gebruiker niet login kan, keert deze methode het koord terug, InvalidLogin.

Verzoek

<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>

Reactie

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