Headless Identity-API'er: forløbet for glemt adgangskode uden headless for kunder og partnere

Din klient anmoder om en adgangskodenulstilling

Når din bruger har startet processen med nulstilling af adgangskode, sender din klient en POST-anmodning til slutpunktet for glemt adgangskode uden headless på din Experience Cloud-lokalitet (1).

Her er URI'en for POST-anmodningen.

/services/auth/headless/forgot_password

Medtag disse sidehoveder i anmodningen.

Medtag disse parametre i anmodningens brødtekst.

Her er der en eksempelanmodning for en offentlig klient, der bruger en tilpasset mailskabelon. Den indeholder et reCAPTCHA-token til sikkerhed og en emailtemplate-parameter med udviklernavnet på en tilpasset skabelon.

POST /services/auth/headless/forgot_password HTTP/1.1
Host: MyDomainName.my.site.com
Content-Type: application/json
{
    "username":"lhansen@example.com",,
    "emailtemplate":"unfiled$public/SalesNewCustomerEmail",
    "recaptcha": "<recaptcha token>"
}

Her er der en eksempelanmodning for en privat klient, der bruger standardmailskabelonen. Det inkluderer et adgangstoken til sikkerhed.

POST /services/auth/headless/forgot_password HTTP/1.1
Host: MyDomainName.my.site.com
Authorization: Bearer 00DR****************
Content-Type: application/json

{
    "username": "lhansen@example.com"
}

Her er der en eksempelanmodning for en privat klient, der bruger headless-brugerdiscovery.

POST /services/auth/headless/forgot_password HTTP/1.1
Host: MyDomainName.my.site.com
Authorization: Bearer 00DR****************
Content-Type: application/json

{
    "login_hint": "<user identifier such as email address, phone number, order number>",
    "customdata": {
        "firstName": "Lyle",
        "lastName": "Hansen"
    }
}

(Valgfrit) Headless-bruger Discovery-handler finder bruger

Hvis du bruger en headless-brugerdiscovery-handler, tager handleren login_hint og customdata-parametre og finder den tilknyttede bruger. Handleren bekræfter, at mailadressen eller telefonnummeret for brugeren er bekræftet.

Hvis du ønsker en eksempelhandler, kan du se Auth.HeadlessUserDiscoveryHandler.

Salesforce returnerer en succesmeddelelse og bekræfter brugernavnet

Når Salesforce modtager anmodningen om glemt adgangskode, sender det en succesmeddelelse til klienten (2). Hvis du ikke bruger en headless discovery-handler, bekræfter Salesforce derefter, at brugernavnet matcher en konto. Hvis brugernavnet ikke matcher en konto, stopper forløbet.

Her er et eksempel på et vellykket svar.

{
    "status": "success",
    "status_code": "otp_sent"
}

Hvis anmodningen mislykkes, returnerer Salesforce en fejlmeddelelse, der beskriver anmodningen. For de fleste fejl returnerer Salesforce fejlmeddelelsen i dette format.

{
"status_code": "<error code>",
"<error name>": "<error description>",
"status": "failed"
}

Hvis f.eks. klienten bruger den forkerte type HTTPS-anmodning, returnerer Salesforce dette fejlsvar.

{
"status_code": "post_required",
"invalid request": "use a POST request",
"status": "failed"
}

For den invalid_recaptcha fejlkode indeholder svaret yderligere oplysninger fra Googles reCAPTCHA-tjeneste. Sådan formateres disse svar.

{
"status_code": "invalid_recaptcha",
"invalid_request: "invalid reCAPTCHA token",
"status": "failed",
"recaptcha_response": {
    "success": <true or false>,
    "challenge_ts": <timestamp of the challenge in ISO format (yyyy-MM-dd'T'HH:mm:ssZZ)>,
    "hostname": "<host name of the client where the reCAPTCHA was solved>",
    "error-codes": [<error codes from Google reCAPTCHA...>]
    }
}

Her er en oversigt over fejlsvarene.

Salesforce genererer og mailer en engangsadgangskode

Salesforce bekræfter, at der findes en konto med brugerens brugernavn i systemet. Hvis kontoen findes, genererer den engangsadgangskode og sender den i en mail (3) til mailadressen på filen. Denne mail genereres ved brug af enten standardmailskabelonen eller ved at referere til en tilpasset skabelon fra emailtemplate-parameteren i den indledende anmodning. Hvis du ønsker oplysninger om tilpasning af mailskabelonen, kan du se Tilpas mail sendt fra Experience Cloud-lokaliteter.

Din klient sender den nye adgangskode

Når klienten modtager succesmeddelelsen fra Salesforce, viser klienten som standard en side til nulstilling af adgangskode for brugeren. Denne side skal indeholde felter for engangsadgangskode og brugerens nye adgangskode. Den nye adgangskode er underlagt Salesforce-adgangskodekravene. Når brugeren har udfyldt disse felter, sender klienten et andet brugernavn, OTP og ny adgangskode i en anden POST-anmodning til slutpunktet for glemt adgangskode (4).

Medtag disse sidehoveder i anmodningen.

Medtag disse parametre i anmodningens brødtekst.

Her er der en eksempelanmodning for en privat klient.

POST /services/auth/headless/forgot_password HTTP/1.1
Host: MyDomainName.my.site.com
Authorization: Bearer 00DR****************
Content-Type: application/json

{
"username": "lhansen@example.com",
"otp" : "123abc",
"newpassword" : "abcd1234"
}

Her er der en lignende anmodning for offentlige klienter, der ikke inkluderer et adgangstoken. Da reCAPTCHA-tokenet blev sendt i den indledende anmodning, er det ikke påkrævet i denne.

POST /services/auth/headless/forgot_password HTTP/1.1
Host: MyDomainName.my.site.com
Content-Type: application/json
{
"username": "lhansen@example.com",
"otp" : "123abc",
"newpassword" : "abcd1234"
}

Salesforce bekræfter adgangskoderne og returnerer en succesmeddelelse

Når Salesforce modtager adgangskodeanmodningen, bekræfter det, at engangsadgangskode er gyldig, og det kontrollerer, at den nye adgangskode opfylder kravene. Hvis disse to kriterier opfyldes, indstilles den nye adgangskode. Når adgangskoden er ændret, sender Salesforce en succesmeddelelse til klienten (5). Sådan ser succesmeddelelsen ud.

{
    "status": "success",
    "status_code": "success"
}

Din klient skal advisere brugeren om, at ændringen er blevet accepteret, og at vedkommende kan logge ind med sin nye adgangskode.

Bemærk

Hvis klienten sender en ukorrekt adgangskode, eller den nye adgangskode ikke opfylder Salesforce-standardsikkerhedskravene, mislykkes nulstillingen af adgangskode. Hvis nulstillingen af adgangskode mislykkes, kan din klient maksimalt oprette fem forsøg på at nulstille adgangskoden ved brug af den samme OTP. Du kontrollerer det maksimale antal forsøg i dine Experience Cloud-indstillinger. Når der er for mange mislykkede forsøg, skal din klient sende en ny indledende anmodning om nulstilling af adgangskode, så der kan genereres en ny engangsadgangskode, som kan sendes med mail til din bruger.

Hvis adgangskodeændringen ikke lykkes, returnerer Salesforce et fejlsvar i dette format.

{
"status_code": "<error code>",
"<error name>": "<error description>",
"status": "failed"
}

Her er en oversigt over fejlene for denne anmodning.