Identiteits-URL's
De identiteits-URL is de gateway naar de Salesforce-identiteitsservice die toegankelijk is met behulp van de OAuth 2.0-gebruiker-agent- of webserverstromen. Wanneer in deze stromen een verbonden app met het bereik id is geautoriseerd, ontvangt deze een identiteits-URL samen met het toegangstoken. De verbonden app kan dan een GET-aanvraag met het toegangstoken verzenden naar de identiteits-URL. Als respons retourneert Salesforce gegevens over de gebruiker en organisatie uit de query.
Vereiste editions
| Beschikbaar in: zowel Salesforce Classic als Lightning Experience |
| Beschikbaar in: Alle editions |
De identiteits-URL wordt geretourneerd in de parameter id. Bijvoorbeeld https://login.salesforce.com/id/00Dx0000000BV7z/005x00000012Q9P.
De identiteits-URL is een op REST gebaseerde API waarmee u een query kunt uitvoeren naar extra informatie over gebruikers, zoals hun gebruikersnaam, e-mailadres en organisatie-ID. De URL retourneert ook eindpunten waarmee de client contact kan hebben, zoals foto's voor profielen en toegankelijke API-eindpunten.
Clienttoegang
Clienttoegang tot de identiteits-URL voor één gebruiker geeft diezelfde identiteits-URL geen toegang tot een andere gebruiker in dezelfde organisatie, tenzij het bijbehorende token aan deze condities voldoet.
- De OAuth-aanvraag voor het toegangstoken omvat het bereik
fullofapi. - Het toegangstoken is voor een gebruiker met de machtiging "API ingeschakeld".
- Het toegangstoken is voor een gebruiker die toegang heeft tot de andere gebruiker in overeenstemming met de regels voor delen van gebruikers van de organisatie.
- Het toegangstoken is voor een interne gebruiker, hetgeen inhoudt dat de waarde user_type in de respons
STANDARDis.
Anders is een toegangstoken voor elke gebruiker vereist om de identiteits-URL van de gebruiker weer te geven.
De indeling van de URL is https://login.salesforce.com/id/orgID/gebrID, waarbij orgId de ID is van de Salesforce-organisatie waartoe de gebruiker behoort, en gebrID de Salesforce-gebruikers-ID is.
Aanvraagparameters van de identiteits-URL
U kunt de volgende parameters gebruiken met het toegangstoken en de identiteits-URL. U kunt het toegangstoken gebruiken in een header van een autorisatieaanvraag of een aanvraag met de parameter oauth_token.
Respons van de identiteits-URL
Als een aanvraag succesvol is, retourneert de respons van de identiteits-URL informatie over de gebruiker en organisatie uit de query.
De volgende respons van een identiteits-URL heeft de XML-indeling.
<?xml version="1.0" encoding="UTF-8"?>
<user xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<id>https://MyDomainName.my.salesforce.com/id/00Dx000.../005x000...</id>
<asserted_user>true</asserted_user>
<user_id>005x000000...</user_id>
<organization_id>00Dx000...</organization_id>
<nick_name>admin1.2777578168398293E12...</nick_name>
<display_name>Alan Van</display_name>
<email>admin@mycompany.com</email>
<status>
<created_date xsi:nil="true"/>
<body xsi:nil="true"/>
</status>
<photos>
<picture>https://MyDomainName--03925205UAF.file.force-user-content.com</picture>
<thumbnail>https://MyDomainName--03925205UAF.file.force-user-content.com</thumbnail>
</photos>
<urls>
<enterprise>https://MyDomainName.my.salesforce.com/services/Soap/c/{version}/00Dx000...</enterprise>
<metadata>https://MyDomainName.my.salesforce.com/services/Soap/m/{version}/00Dx000...</metadata>
<partner>https://MyDomainName.my.salesforce.com/services/Soap/u/{version}/00Dx000...</partner>
<rest>https://MyDomainName.my.salesforce.com/services/data/v{version}/
</rest>
<sobjects>https://MyDomainName.my.salesforce.com/services/data/v{version}/sobjects/
</sobjects>
<search>https://MyDomainName.my.salesforce.com/services/data/v{version}/search/
</search>
<query>https://MyDomainName.my.salesforce.com/services/data/v{version}/query/
</query>
<profile>https://MyDomainName.my.salesforce.com/005x000...</profile>
</urls>
<active>true</active>
<user_type>STANDARD</user_type>
<language>en_US</language>
<locale>en_US</locale>
<utcOffset>-28800000</utcOffset>
<last_modified_date>2021-04-28T20:54:09.000Z</last_modified_date>
</user>En dit is een respons in JSON-indeling.
{"id":"https://MyDomainName.my.salesforce.com/id/00Dx000.../005x000...",
"asserted_user":true,
"user_id":"005x000...",
"organization_id":"00Dx000...",
"nick_name":"admin1.2777578168398293E12...",
"display_name":"Alan Van",
"email":"admin@mycompany.com",
"status":{"created_date":null,"body":null},
"photos":{"picture":"https://MyDomainName--03925205UAF.file.force-user-content.com",
"thumbnail":"https://MyDomainName--03925205UAF.file.force-user-content.com"},
"urls":
{"enterprise":"https://MyDomainName.my.salesforce.com/services/Soap/c/{version}/00Dx000...",
"metadata":"https://MyDomainName.my.salesforce.com/services/Soap/m/{version}/00Dx000...",
"partner":"https://MyDomainName.my.salesforce.com/services/Soap/u/{version}/00Dx000...",
"rest":"https://MyDomainName.my.salesforce.com/services/data/v{version}/",
"sobjects":"https://MyDomainName.my.salesforce.com/services/data/v{version}/sobjects/",
"search":"https://MyDomainName.my.salesforce.com/services/data/v{version}/search/",
"query":"https://MyDomainName.my.salesforce.com/services/data/v{version}/query/",
"profile":"https://MyDomainName.my.salesforce.com/005x000..."},
"active":true,
"user_type":"STANDARD",
"language":"en_US",
"locale":"en_US",
"utcOffset":-28800000,
"last_modified_date":"2021-04-28T20:54:09.000+0000"}In deze tabel worden de geretourneerde parameters beschreven.
| Parameter | Beschrijving |
|---|---|
id
|
Identiteits-URL, dezelfde URL als de URL uit de query. |
asserted_user
|
Booleaanse waarde die aangeeft of het opgegeven toegangstoken is uitgegeven voor deze identiteit. |
user_id
|
Gebruikers-ID van de gebruiker uit de query. |
username
|
Gebruikersnaam van de gebruiker uit de query. |
organization_id
|
ID van de Salesforce-organisatie van de gebruiker uit de query. |
nick_name
|
Experience Cloud-bijnaam van de gebruiker waarop een query wordt uitgevoerd. |
display_name
|
Weergavenaam (volledige naam) van de gebruiker uit de query |
email
|
E-mailadres van de gebruiker uit de query. |
email_verified
|
Geeft aan of het e-mailadres van de gebruiker uit de query is geverifieerd door klikken op een koppeling in de "Welkom bij Salesforce" e-mail. De waarde email_verified wordt ingesteld op
|
first_name
|
Voornaam van de gebruiker uit de query. |
last_name
|
Achternaam van de gebruiker uit de query. |
timezone
|
Tijdzone die is opgegeven in de instellingen van de gebruiker uit de query. |
photos
|
Toewijzing van URL's aan de profielfoto's van de gebruiker uit de query, opgegeven als Opmerking Voor toegang tot deze URL's is een toegangstoken nodig. Zie toegangstoken. |
addr_street
|
Straat die is opgegeven in het adres van de instellingen van de gebruiker uit de query. |
addr_city
|
Plaats die is opgegeven in het adres van de instellingen van de gebruiker uit de query. |
addr_state
|
Staat die is opgegeven in het adres van de instellingen van de gebruiker uit de query. |
addr_country
|
Land dat is opgegeven in het adres van de instellingen van de gebruiker uit de query. |
addr_zip
|
Postcode die is opgegeven in het adres van de instellingen van de gebruiker uit de query. |
mobile_phone
|
Mobiel telefoonnummer dat is opgegeven in de instellingen van de gebruiker uit de query. |
mobile_phone_verified
|
De gebruiker uit de query heeft bevestigd dat het mobiele telefoonnummer geldig is. |
status
|
Huidige Chatter-status van de gebruiker uit de query.
|
urls
|
Toewijzing met diverse API-eindpunten die kunnen worden gebruikt met de gebruiker uit de query. Opmerking Toegang tot de REST-eindpunten vereist het doorgeven van een toegangstoken. Zie toegangstoken.
|
active
|
Booleaanse waarde die opgeeft of de gebruiker uit de query actief is. |
user_type
|
Type van de gebruiker uit de query. |
language
|
Taal van de gebruiker uit de query. |
locale
|
Omgeving van de gebruiker uit de query. |
utcOffset
|
Verschil tussen de tijdzone van de gebruiker uit de query en UTC, in milliseconden. |
last_modified_date
|
xsd datetime van de laatste wijziging van de gebruiker, bijvoorbeeld 2010-06-28T20:54:09.000Z. |
is_app_installed
|
Waarde is true wanneer de verbonden app is geïnstalleerd in de organisatie van de gebruiker en het toegangstoken van de gebruiker is gemaakt met behulp van een OAuth-stroom. Als de verbonden app niet is geïnstalleerd, bevat de respons deze waarde niet. Controleer wanneer de respons wordt gecontroleerd op het bestaan en de waarde van deze eigenschap. |
mobile_policy
|
Specifieke waarden voor het beheer van een mobiele verbonden app. Deze waarden zijn alleen beschikbaar wanneer de verbonden app is geïnstalleerd in de organisatie van de huidige gebruiker, de app een gedefinieerde waarde voor sessietime-out heeft en voor de mobiele PIN (Personal Identification Number) een lengtewaarde is gedefinieerd.
|
push_service_type
|
Stel dit in op De responswaarde type is een array. |
custom_permissions
|
Wanneer een verzoek de parameter Hier is een voorbeeld van een verzoek. Hier is het JSON-blok in de respons van de identiteits-URL. |
Potentiële fouten
Nadat een ongeldige aanvraag is gedaan, zijn de volgende foutresponsen van Salesforce mogelijk.
| 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 |
