Loading
Identifiera dina användare och hantera åtkomst
Sökfråga för användarinformation

Sökfråga för användarinformation

En ansluten app kan fråga UserInfo-slutpunkten om information om användaren som är associerad med den anslutna appens åtkomsttoken. Salesforce returnerar grundläggande personlig information om användaren och viktiga slutpunkter som den anslutna appen kan kommunicera med, som foton och tillgängliga API-slutpunkter. Denna UserInfo-slutpunkt ger åtkomst till information endast för den aktuella användaren. Den ger inte åtkomst till andra användare i organisationen.

Versioner som krävs

Tillgängliga i: både Salesforce Classic och Lightning Experience
Tillgängliga i: Alla versioner

UserInfo-slutpunkten är en RESTful API som definieras av OpenID Connect. Formatet för slutpunktens URL är: https://login.salesforce.com/services/oauth2/userinfo.

Anteckning
Anteckning För Sandbox ersätts login.salesforce.com med test.salesforce.com. För Experience Cloud-webbplatser ersätts login.salesforce.com med webbplatsens URL, till exempel MinDomänNamn.my.site.com/.well-known/openid-configuration. URL:en måste vara HTTPS.

Här är flödet för att fråga UserInfo-slutpunkten.

  1. Den anslutna appen skickar en sökfråga till Salesforce UserInfo-slutpunkten. Sökfrågan måste innehålla den anslutna appens åtkomsttoken.
  2. Salesforce svarar med användarens information.

Fråga UserInfo-slutpunkten

Använd dessa parametrar för att fråga UserInfo-slutpunkten. Du kan använda åtkomsttoken i ett sidhuvud för auktoriseringsbegäran eller i en begäran med parametern oauth_token.

Viktig
Viktig När du utvecklar OAuth-integreringar, skicka alltid känslig information i brödtexten i en POST-begäran eller i ett begärandesidhuvud. Använd inte GET-parametrar i URL-frågesträngen för att skicka känslig information. Känslig information inkluderar men är inte begränsad till användarnamn, lösenord, OAuth-tokens, klienthemligheter och all personligt identifierande information. Mer information om rekommenderade metoder för säkerhet finns i Lagra känsliga data i Säker kodningsguide.
Parameter Beskrivning
oauth_toke n OAuth-token som en ansluten app använder för att begära åtkomst till en skyddad resurs åt klientprogrammet. Ytterligare behörigheter i form av omfattningar kan medfölja åtkomsttoken.
format

Tillval. Ange formatet för den returnerade utmatningen. Värden är:

  • json
  • xml

Klienten kan även specificera det returnerade formatet i ett sidhuvud för accepterad-begärd med en av följande:

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

Begäransidhuvudet har även stöd för följande.

  • Jokertecknet */* accepteras och returnerar JSON.
  • En lista över värden som kontrolleras vänster-till-höger. Till exempel: application/xml,application/json,application/html,*/* returnerar XML.

Parametern format har företräde framför sidhuvudet för åtkomstbegäran.

version Tillval. Specificera ett SOAP API-versionsnummer eller den bokstavliga strängens latest. Om detta värde inte specificeras innehåller de returnerade API URL:erna det litterära värdet {version} istället för versionsnumret. Om värdet är angivet som latest används den senaste API-versionen.
PrettyPrint Tillval. Accepteras endast i ett sidhuvud och inte som en URL-parameter. Specificera denna parameter att optimera den returnerade XML- eller JSON-utmatningen för läsbarhet snarare än storlek. Använd t.ex. följande i en rubrik: X-PrettyPrint:1.
callback

Tillval. Specificera ett giltigt funktionsnamn för JavaScript. Du kan använda denna parameter när det specificerade formatet är JSON. Utmatningen är omgiven av detta funktionsnamn (JSONP). Till exempel, om en begäran till https://server/id/orgid/userid/ returnerar {"function":"name"}, returnerar en begäran till https://server/id/orgid/userid/?callback=baz baz({"function":"name"});.

Anteckning
Anteckning JSONP returneras inte längre för begäran av identitetstjänster på grund av strikt NIME-skrivning. Dina begäranden måste lägga till 'format=jsonp' med callback-parametern så att identitetstjänsten returnerar JavaScript. När identitetstjänsten upptäcker JSONP-formatet returneras den JavaScript-typ ('application/javascript') som behövs.
is_salesforce_integration_user Tillval. Specificera denna parameter för att avgöra om användaren har användarlicensen Salesforce Integration.

Salesforce UserInfo-slutpunkten svarar

Efter en giltig begäran returnerar Salesforce information i JSON-format, som standard, eller det som specificeras i format-parametern.

Svaret inkluderar värden som listas i OpenID Connect Basic Client Profile, Salesforces användar-ID, organisations-ID, kanal och profil-URL:er.

I svaret reflekterar attributet email_verified om användarna verifierar sin e-postadress efter att följande inträffat: Till exempel: En Salesforce-administratör skapar användaren Roberta Smith. Roberta får e-postmeddelandet ”Välkommen till Salesforce” med en länk för att bekräfta hennes konto. När hon har klickat på länken sätts värdet email_verified till true.

  • De ändrar sin e-postadress
  • De ändrar sitt lösenord, eller en Salesforce-administratör återställer deras lösenord
  • De bekräftar sin identitet när de loggar in från en ny webbläsare eller enhet
  • En Salesforce-administratör skapar dem som en ny användare

Följande är ett 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öljande är ett svar i XML-formatet:

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

Här är beskrivningar för de returnerade parametrarna.

Parameter Beskrivning
sub URL för UserInfo-slutpunkten, vilket är samma URL som frågades.
user_id Användar-ID för den frågade användaren.
organization_id ID för Salesforce-organisationen för användaren.
preferred_username Användarnamn för den frågade användaren.
nickname Experience Cloud-smeknamn för den frågade användaren.
name Den frågade användarens visningsnamn (fullständiga namn)
email E-postadress för användaren
email_verified

Indikerar om den frågade användarens e-postadress har bekräftats genom att klicka på länken i e-postmeddelandet "Välkommen till Salesforce".

Värdet email_verified är inställt till true när användare klickar på en länk i det e-postmeddelande de får efter att detta scenario inträffar: Till exempel: En Salesforce-administratör skapar användaren Roberta Smith. Roberta får e-postmeddelandet ”Välkommen till Salesforce” med en länk för att bekräfta hennes konto. När hon har klickat på länken sätts värdet email_verified till true.

  • De ändrar sin e-postadress
  • De ändrar sitt lösenord, eller en Salesforce-administratör återställer deras lösenord
  • De bekräftar sin identitet när de loggar in från en ny webbläsare eller enhet
  • En Salesforce-administratör skapar dem som en ny användare
given_name Den frågade användarens förnamn.
family_name Den frågade användarens efternamn.
zoneinfo Tidszonen som specificeras i den frågade användarens inställningar
photos

Karta över URL:er till den frågade användarens profilbilder, specificerade som picture, thumbnail eller profile.

Anteckning
Anteckning Att komma åt dessa URL-adresser kräver en åtkomsttoken.
address Adress för den frågade användaren, vilket kan vara användarens gata, ort, delstat, land och postnummer.
mobile_phone Mobilnumret som specificerats i adressen i den frågade användarens inställningar
mobile_phone_verified Användaren har bekräftat att mobiltelefonnumret är giltigt.
urls

Karta som innehåller olika API-slutpunkter som kan användas med den frågade användaren

Anteckning
Anteckning Att komma åt REST-slutpunkter kräver en åtkomsttoken.
  • enterprise (TVÅL)
  • metadata (TVÅL)
  • partner (TVÅL)
  • rest (REST)
  • sobjects (REST)
  • search (REST)
  • query (REST)
  • recent (REST)
  • profile
  • feeds (Chatter)
  • feed-items (Chatter)
  • groups (Chatter)
  • users (Chatter)
  • custom_domain

    Detta värde utelämnas om organisationen inte har en egen domän konfigurerad och distribuerad.

active Ett booleskt värde som anger om användaren är aktiv.
user_type Typ av frågad användare.
language Språk för frågad användare.
locale Plats för frågad användare.
utcOffset Förskjutning från UTC i den frågade användarens tidszon, i millisekunder.
updated_at xsd datetime för den senaste ändringen av användaren, till exempel 2010-06-28T20:54:09.000Z.
is_app_installed Värde är true när den anslutna appen är installerad i användarens organisation och användarens åtkomsttoken skapades med ett OAuth-flöde. Om den anslutna appen inte är installerad innehåller svaret inte detta värde. Vid tolkning av svaret, kontrollera både existens och värde för denna egenskap.
mobile_policy

Specifika värden för hantering av en ansluten app för mobil. Dessa värden är endast tillgängliga när den anslutna appen är installerat i organisationen för den aktuella användaren och appen har ett definierat värde för sessionstimeout och ett längdvärde för mobil PIN-kod.

  • screen_lock—Längre tid att vänta för att låsa skärmen efter inaktivitet.
  • pin_length—Längd på det identifikationsnummer som krävs för att få åtkomst till mobilappen.
push_service_type

Sätt till apple om den anslutna appen är registrerad med Apple Push Notification Service (APNS) för iOS pushnotiser. Sätt till androidGcm om det är registrerat med Google Cloud Messaging (GCM) för Android-pushnotiser.

Svarsvärdestypen är en matris.

custom_permissions

När en begäran innehåller custom_permissions inkluderar svaret en karta som innehåller egna behörigheter i organisationen som är associerad med den anslutna appen. Om den anslutna appen inte är installerad i organisationen eller inte har några associerade egna behörigheter innehåller svaret ingen custom_permissions.

Här är en exempelbegäran.

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
         

Här är JSON-blocket i identitets-URL-svaret.

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

Följande är möjliga svar från Salesforce till en ogiltig begäran.

Felkod Begärandeproblem
403 (förbjudet) — HTTPS_Required HTTP
403 (förbjuden) — Missing_OAuth_Token Saknad åtkomsttoken
403 (förbjuden) — Bad_OAuth_Token Ogiltig åtkomsttoken
403 (förbjuden) — Wrong_Org Användare i en annan organisation
404 (hittades inte) — Bad_Id Ogiltig eller felaktig användare eller organisations-ID
404 (hittades inte) — Inactive Inaktiverade användare eller inaktiv organisation
404 (hittades inte) — No_Access Användare saknar lämplig åtkomst till organisation eller information
404 (hittades inte) — No_Site_Endpoint Begäran till en ogiltig slutpunkten av en sida
404 (hittades inte) — Internt fel Inget svar från server
406 (inte acceptabel) — Invalid_Version Ogiltig version
406 (inte acceptabel) — Invalid_Callback Ogiltig uppkallning
 
Laddar
Salesforce Help | Article