Query uitvoeren op gebruikersgegevens
Een verbonden app kan een query op het eindpunt UserInfo uitvoeren voor informatie over de gebruiker die is gekoppeld aan het toegangstoken van de verbonden app. Salesforce retourneert elementaire persoonlijke gegevens over de gebruiker en belangrijke eindpunten waarmee de client kan communiceren, zoals foto's en toegankelijke API-eindpunten. Dit eindpunt UserInfo biedt alleen voor de huidige gebruiker toegang tot gegevens. Het biedt geen toegang aan andere gebruikers in de organisatie.
Vereiste editions
| Beschikbaar in: zowel Salesforce Classic als Lightning Experience |
| Beschikbaar in: Alle editions |
Het eindpunt UserInfo is een RESTful-API die wordt gedefinieerd door OpenID Connect. De indeling van de URL van het eindpunt is: https://login.salesforce.com/services/oauth2/userinfo.
Dit is de stroom voor het uitvoeren van query's op het eindpunt UserInfo.
- De verbonden app stuurt een query naar het Salesforce UserInfo-eindpunt. De query moet het toegangstoken van de verbonden app bevatten.
- Salesforce antwoordt met de gegevens van de gebruiker.
Query uitvoeren op het eindpunt UserInfo
Gebruik deze parameters om een query uit te voeren op het eindpunt UserInfo. U kunt het toegangstoken gebruiken in een header van een autorisatieaanvraag of in een aanvraag met de parameter oauth_token.
Salesforce-eindpunt UserInfo antwoordt
Na het doen van een geldige aanvraag retourneert Salesforce de informatie standaard in JSON-indeling of de indeling die is opgegeven in de parameter Format.
De reactie bevat waarden die worden vermeld in OpenID Connect Basic Client Profile, Salesforce-gebruikers-ID, organisatie-ID, feed en profiel-URL’s.
In de respons weerspiegelt het kenmerk email_verified of gebruikers hun e-mailadres verifiëren na dit scenario: Een Salesforce-beheerder maakt bijvoorbeeld de gebruiker Roberta Smith. Roberta ontvangt het e-mailbericht "Welkom bij Salesforce" met een koppeling om haar account te controleren. Nadat ze op de koppeling heeft geklikt, wordt de waarde email_verified ingesteld op true.
- Zij hun e-mailadres wijzigen
- Zij hun wachtwoord wijzigen of een Salesforce-beheerder hun wachtwoord opnieuw instelt
- Gebruikers controleren hun identiteit wanneer ze inloggen vanaf een nieuw apparaat of browser
- Een Salesforce-beheerder hen als een nieuwe gebruiker maakt
Het volgende is een respons in JSON-indeling.
{"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"}Het volgende is een respons in XML-indeling.
<?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>Hieronder worden de geretourneerde parameters beschreven.
De volgende zijn de mogelijke reacties uit Salesforce op een ongeldig verzoek.
| Foutcode | Probleem met verzoek |
|---|---|
| 403 (verboden) — HTTPS_Required | HTTP |
| 403 (verboden) — Missing_OAuth_Token | Ontbrekend toegangstoken |
| 403 (verboden) — Bad_OAuth_Token | Ongeldig toegangstoken |
| 403 (verboden) — Wrong_Org | Gebruikers in een andere organisatie |
| 404 (niet gevonden) — Bad_Id | Ongeldige of onjuiste gebruikers- of organisatie-ID |
| 404 (niet gevonden) — Inactive | Gedeactiveerde gebruiker of inactieve organisatie |
| 404 (niet gevonden) — No_Access | Gebruiker heeft geen juiste toegang tot organisatie of informatie |
| 404 (niet gevonden) — No_Site_Endpoint | Verzoek aan een ongeldig eindpunt van een site |
| 404 (niet gevonden) — Interne fout | Geen reactie van de server |
| 406 (niet acceptabel) — Invalid_Version | Ongeldige versie |
| 406 (niet acceptabel) — Invalid_Callback | Ongeldige callback |
