Loading
Identifisere brukerne og administrere tilgang
Spørring for brukerinformasjon

Spørring for brukerinformasjon

En tilkoblet app kan spørre UserInfo-sluttpunktet om informasjon om brukeren som er tilknyttet den tilkoblede appens tilgangstoken. Salesforce returnerer grunnleggende personopplysninger om brukeren og viktige sluttpunkter som den tilkoblede appen kan kommunisere med, som bilder og tilgjengelige API-sluttpunkter. Dette UserInfo-sluttpunktet gir tilgang til informasjon bare for den gjeldende brukeren. Det gir ikke tilgang til andre brukere i organisasjonen.

Nødvendige utgaver

Tilgjengelig i både Salesforce Classic og Lightning Experience
Tilgjengelig i alle versjoner

UserInfo-sluttpunktet er en RESTful API definert av OpenID Connect. Formatet på sluttpunktets URL-adresse er: https://login.salesforce.com/services/oauth2/userinfo.

Merk
Merk login.salesforce.com erstattes med test.salesforce.com for en Sandbox-organisasjon. Når det gjelder Experience Cloud-nettsteder, blir login.salesforce.com erstattet med nettstedets URL-adresse, for eksempel NavnPåMittDomene.my.site.com/.well-known/openid-configuration. URL-adressen må være HTTPS.

Her er flyten for spørring av sluttpunktet UserInfo.

  1. Den tilkoblede appen sender en spørring til Salesforce UserInfo-sluttpunkt. Spørringen må inneholde den tilkoblede appens tilgangstoken.
  2. Salesforce svarer med brukerens informasjon.

Spørring sluttpunktet UserInfo

Bruk følgende parametere til å spørre sluttpunktet UserInfo. Du kan bruke tilgangstokenet i et godkjenningsforespørselshode eller i en forespørsel med oauth_token-parameteren.

Viktig
Viktig Når du utvikler OAuth-integrasjoner, overfører du alltid sensitiv informasjon i hoveddelen av en POST-forespørsel eller i et forespørselshode. Ikke bruk GET-parametere i URL-spørrestrengen til å overføre sensitiv informasjon. Sensitiv informasjon inkluderer, men er ikke begrenset til brukernavn, passord, OAuth-tokener, klienthemmeligheter og eventuell personlig identifiserbar informasjon. Hvis du vil ha mer informasjon om gode fremgangsmåter for sikkerhet, kan du se Lagre sensitive data i Secure Coding Guide.
Parameter Beskrivelse
oauth_toke n OAuth-token som en tilkoblet app bruker til å be om tilgang til en beskyttet ressurs på vegne av klientprogrammet. Andre tillatelser i form av omfang kan følge med tilgangstokenet.
format

Valgfritt. Angi formatet på de returnerte utdataene. Mulige verdier er følgende:

  • json
  • xml

Klienten kan også angi det returnerte formatet i et accept-forespørselshode med et av følgende formater.

  • Accept: application/json
  • Accept: application/xml
  • Accept: application/x-www-form-urlencoded

Forespørselshodet støtter også følgende.

  • Jokertegnet */* godtas og returnerer JSON.
  • En liste over verdier, som kontrolleres fra venstre til høyre. Eksempel: application/xml,application/json,application/html,*/* returnerer XML.

format-parameteren prioriteres foran tilgangsforespørselshodet.

version Valgfritt. Angi et SOAP API-versjonsnummer eller den litterale strengen latest. Hvis denne verdien ikke angis, inneholder de returnerte API-URL-adressene den litterale verdien {version} i stedet for versjonsnummeret. Hvis verdien angis som latest, brukes den nyeste API-versjonen.
PrettyPrint Valgfritt. Godtas bare i et hode, ikke som en URL-parameter. Angi denne parameteren for å optimere de returnerte XML- eller JSON-utdataene for leselighet i stedet for størrelse. Bruk for eksempel følgende i et hode: X-PrettyPrint:1.
callback

Valgfritt. Angi et gyldig JavaScript-funksjonsnavn. Du kan bruke denne parameteren når det angitte formatet er JSON. Utdataene pakkes inn i dette funksjonsnavnet (JSONP). Hvis for eksempel en forespørsel til https://server/id/orgid/userid/ returnerer {"function":"name"}, returnerer en forespørsel til https://server/id/orgid/userid/?callback=baz baz({"function":"name"});.

Merk
Merk JSONP returneres ikke lenger for identitetstjenesteforespørsler på grunn av streng MIME-skriving. Forespørslene må legge til 'format=jsonp' med tilbakekallsparameteren slik at Identitetstjeneste returnerer JavaScript. Når Identitetstjeneste oppdager JSONP-formatet, returnerer den nødvendige JavaScript-typen ('application/javascript').
is_salesforce_integration_user Valgfritt. Angi denne parameteren for å finne ut om brukeren har brukerlisensen Salesforce Integration.

Salesforce-sluttpunktet UserInfo svarer

Etter å ha sendt en gyldig forespørsel returnerer Salesforce informasjonen i JSON-format som standard, eller i formatet som er angitt i format-parameteren.

Svaret inkluderer verdier vist i OpenID Connect Basic Client Profile, Salesforce-bruker-IDen, organisasjons-IDen og URL-adresser for profil.

I svaret gjenspeiler attributtet email_verified om brukere bekrefter e-postadressen sin når følgende skjer: Anta for eksempel at en Salesforce-administrator oppretter brukeren Roberta Smith. Roberta "Velkommen til Salesforce"-e-postmelding med en lenke til kontoen hennes. Når hun klikker på lenken, settes email_verified-verdien til true.

  • de har endret e-postadressen sin
  • de har endret passordet sitt eller en Salesforce-administrator har tilbakestilt passordet deres
  • de bekrefter sin identitet når de logger på fra en ny enhet eller nettleser
  • en Salesforce-administrator har opprettet dem som nye brukere

Følgende er et svar i JSON-format.

{"sub":"https://login.salesforce.com/id/00Dx000.../005x000...",
"user_id":"005x000...",
"organization_id":"00Dx000...",
"name":"yourInstance LastName",
"email":"user1@1135222488950007.com",
"email_verified":true,"given_name":"yourInstance","family_name":"LastName",
"zoneinfo":"America/Los_Angeles",
"photos":{"picture":"https://yourInstance.salesforce.com/profilephoto/005/F","thumbnail":"https://yourInstance.salesforce.com/profilephoto/005/T"},
"profile":"https://yourInstance.salesforce.com/005x000...",
"picture":"https://yourInstance.salesforce.com/profilephoto/005/F",
"address":{"country":"us"},
"urls":{"enterprise":"https://yourInstance.salesforce.com/services/Soap/c/{version}/00Dx00...",
"partner":"https://yourInstance.salesforce.com/services/Soap/u/{version}/00Dx00...",
"rest":"https://yourInstance.salesforce.com/services/data/v{version}/",
"sobjects":"https://yourInstance.salesforce.com/services/data/v{version}/sobjects/",
"search":"https://yourInstance.salesforce.com/services/data/v{version}/search/",
"query":"https://yourInstance.salesforce.com/services/data/v{version}/query/",
"recent":"https://yourInstance.salesforce.com/services/data/v{version}/recent/",
"profile":"https://yourInstance.salesforce.com/005x000...",
"feeds":"https://yourInstance.salesforce.com/services/data/v{version}/chatter/feeds",
"groups":"https://yourInstance.salesforce.com/services/data/v{version}/chatter/groups",
"users":"https://yourInstance.salesforce.com/services/data/v{version}/chatter/users",
"feed_items":"https://yourInstance.salesforce.com/services/data/v{version}/chatter/feed-items"},
"active":true,"user_type":"STANDARD","language":"en_US","locale":"en_US",
"utcOffset":-28800000,"updated_at":"2013-12-02T18:46:42Z"}

Følgende er et svar i XML-format

<?xml version="1.0" encoding="UTF-8"?>
<user>
<sub>https://login.salesforce.com/id/00Dx000.../005x000...</sub>
<user_id>005x000...</user_id>
<organization_id>00Dx000...</organization_id>
<preferred_username>user1@1135222488950007.com</preferred_username>
<nickname>user1.3860098879512678E12</nickname>
<name>user1 LastName</name>
<email>user1@1135222488950007.com</email>
<email_verified>true</email_verified>
<given_name>user1</given_name>
<family_name>LastName</family_name>
<zoneinfo>America/Los_Angeles</zoneinfo>
<photos>
<picture>https://yourInstance.salesforce.com/profilephoto/005/F</picture>
<thumbnail>https://yourInstance.salesforce.com/profilephoto/005/T</thumbnail></photos>
<profile>https://yourInstance.salesforce.com/005x000...</profile>
<picture>https://yourInstance.salesforce.com/profilephoto/005/F</picture>
<address>
<country>us</country>
</address>
<urls>
<enterprise>https://yourInstance.salesforce.com/services/Soap/c/{version}/00Dx0000002rIh1</enterprise>
<metadata>https://yourInstance.salesforce.com/services/Soap/m/{version}/00Dx0000002rIh1</metadata>
<partner>https://yourInstance.salesforce.com/services/Soap/u/{version}/00Dx0000002rIh1</partner>
<rest>https://yourInstance.salesforce.com/services/data/v{version}/</rest>
<sobjects>https://yourInstance.salesforce.com/services/data/v{version}/sobjects/</sobjects>
<search>https://yourInstance.salesforce.com/services/data/v{version}/search/</search>
<query>https://yourInstance.salesforce.com/services/data/v{version}/query/</query>
<recent>https://yourInstance.salesforce.com/services/data/v{version}/recent/</recent>
<profile>https://yourInstance.salesforce.com/005x000...</profile>
<feeds>https://yourInstance.salesforce.com/services/data/v{version}/chatter/feeds</feeds>
<groups>https://yourInstance.salesforce.com/services/data/v{version}/chatter/groups</groups>
<users>https://yourInstance.salesforce.com/services/data/v{version}/chatter/users</users>
<feed_items>https://yourInstance.salesforce.com/services/data/v{version}/chatter/feed-items</feed_items>
</urls>
<active>true</active>
<user_type>STANDARD</user_type>
<language>en_US</language>
<locale>en_US</locale>
<utcOffset>-28800000</utcOffset>
<updated_at>2013-12-02T18:46:42.000Z</updated_at>
</user>

Her er beskrivelser av de returnerte parameterne.

Parameter Beskrivelse
sub URL-adressen til UserInfo-endepunktet, som er samme URL-adresse som det ble spurt om.
user_id Bruker-ID for brukeren som det spørres etter.
organization_id ID for Salesforce-organisasjonen for brukeren som det spørres etter.
preferred_username Brukernavn for brukeren som det spørres etter.
nickname Experience Cloud-kallenavn på brukeren som det spørres etter.
name Visningsnavn (fullt navn) på brukeren som det spørres etter.
email Epost-adresse til brukeren som det spørres etter.
email_verified

Viser om e-postadresse til brukeren som det spørres etter, ble bekreftet ved å klikke på en lenke i Velkommen til Salesforce-e-postmeldingen.

Verdien email_verified settes til true når brukere klikker på en lenke i e-postmeldingen de mottar etter at dette scenariet oppstår: Anta for eksempel at en Salesforce-administrator oppretter brukeren Roberta Smith. Roberta "Velkommen til Salesforce"-e-postmelding med en lenke til kontoen hennes. Når hun klikker på lenken, settes email_verified-verdien til true.

  • de har endret e-postadressen sin
  • de har endret passordet sitt eller en Salesforce-administrator har tilbakestilt passordet deres
  • de bekrefter sin identitet når de logger på fra en ny enhet eller nettleser
  • en Salesforce-administrator har opprettet dem som nye brukere
given_name Fornavnet til brukeren som det spørres etter.
family_name Fornavnet til brukeren som det spørres etter.
zoneinfo Tidssone som er angitt innstillingene til brukeren som det spørres etter.
photos

Tilordne URL-adresser til profilbildene til brukeren som det spørres etter, angitt som picture, thumbnail eller profile.

Merk
Merk Tilgang til disse URL-adressene krever at et tilgangstoken sendes.
address Adressen til brukeren det spørres etter, som kan inkludere brukerens gateadresse, poststed, delstat, land og postnummer.
mobile_phone Mobiltelefonnummer som er angitt i innstillingene til brukeren som det spørres etter.
mobile_phone_verified Brukeren som det spørres etter, har bekreftet at mobiltelefonnummeret er gyldig.
urls

Tilordning som inneholder forskjellige API-sluttpunkter som kan brukes med brukeren som det spørres etter.

Merk
Merk Tilgang til REST-sluttpunktene krever at et tilgangstoken sendes.
  • enterprise (SOAP)
  • metadata (SOAP)
  • partner (SOAP)
  • rest (REST)
  • sobjects (REST)
  • search (REST)
  • query (REST)
  • recent (REST)
  • profile
  • feeds (Chatter)
  • feed-items (Chatter)
  • groups (Chatter)
  • users (Chatter)
  • custom_domain

    Hvis organisasjonen ikke har et tilpasset domene konfigurert og overført, utelates denne verdien.

active Boolsk verdi som angir om brukeren som det spørres etter, er aktiv.
user_type Brukertypen for brukeren som det spørres etter.
language Språk for brukeren som det spørres etter.
locale Nasjonal innstilling for brukeren som det spørres etter.
utcOffset Forskyvning i millisekunder fra UTC for tidssonen for brukeren som det spørres etter.
updated_at xsd datetime-format for brukerens siste endring, for eksempel 2010-06-28T20:54:09.000Z.
is_app_installed Verdi er true når den tilkoblede appen er installert i brukerens organisasjon, og brukerens tilgangstoken ble opprettet med en OAuth-flyt. Hvis den tilkoblede appen ikke er installert, inneholder svaret ikke denne verdien. Når du analyserer svaret, kontrollerer du eksistensen av og verdien for denne egenskapen.
mobile_policy

Spesifikk verdier for behandling av en tilkoblet mobilapp. Disse verdiene er tilgjengelige bare når den tilkoblede appen er installert i den gjeldende brukerens organisasjon og appen har en definert tidsavbruddsverdi og mobil-PIN-koden har en lengdeverdi definert.

  • screen_lock: Hvor lang tid det tar å låse skjermen etter inaktivitet.
  • pin_length: Lengden på identifikasjonsnummeret som kreves for å få tilgang til mobilappen.
push_service_type

Angi til apple hvis den tilkoblede appen er registrert med Apple Push Notification Service (APNS) for iOS-push-varsler. Sett til androidGcm hvis den er registrert med Google Cloud Messaging (GCM) for Android-push-varsler.

Svarverditypen er en matrise.

custom_permissions

Når en forespørsel inkluderer custom_permissions scope-parameteren, inkluderer svaret et kart som inneholder tilpassede tillatelser i organisasjonen som er tilknyttet den tilkoblede appen. Hvis den tilkoblede appen ikke er installert i organisasjonen eller ikke har noen tilknyttede tilpassede tillatelser, inneholder ikke svaret et custom_permissions.

Her er et eksempel på en forespørsel.

http://MyDomainName.my.salesforce.com/services/oauth2/authorize?response_type=token&client_
          id=3MVG9lKcPoNINVBKV6EgVJiF.snSDwh6_2wSS7BrOhHGEJkC_&redirect_uri=http://www.example.org/qa/security/oauth
          /useragent_flow_callback.jsp&scope=api%20id%20custom_permissions
         

Her er JSON-blokken i svaret med URL-adressen for identitet.

"custom_permissions":
           {
           "Email.View":true,
           "Email.Create":false,
           "Email.Delete":false
           }
          

Følgende er mulige svar fra Salesforce til en ugyldig forespørsel.

Feilkode Problem i forespørsel
403 (forbidden) — HTTPS_Required HTTP
403 (forbidden) — Missing_OAuth_Token Mangler tilgangstoken
403 (forbidden) — Bad_OAuth_Token Ugyldig tilgangstoken
403 (forbidden) — Wrong_Org Brukere i en annen organisasjon
404 (not found) — Bad_Id Ugyldig eller feil bruker eller organisasjons-ID
404 (not found) — Inactive Deaktivert bruker eller inaktiv organisasjon
404 (not found) — No_Access Bruker mangler riktig tilgang til organisasjon eller informasjon
404 (not found) — No_Site_Endpoint Forespørsel til et ugyldig sluttpunkt på et sted
404 (not found) – Intern feil Ikke svar fra server
406 (not acceptable) — Invalid_Version Ugyldig versjon
406 (not acceptable) — Invalid_Callback Ugyldig tilbakekall
 
Laster
Salesforce Help | Article