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.
Här är flödet för att fråga UserInfo-slutpunkten.
- Den anslutna appen skickar en sökfråga till Salesforce UserInfo-slutpunkten. Sökfrågan måste innehålla den anslutna appens åtkomsttoken.
- 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.
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.
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 |
