Using Identity URLs

The Identity URL is returned in the id scope parameter. For example, https://login.salesforce.com/id/00Dx0000000BV7z/005x00000012Q9P.

The identity URL is also a RESTful API to query for additional information about users, such as their username, email address, and org ID. It also returns endpoints that the client can talk to, such as photos for profiles and accessible API endpoints.

The format of the URL is https://login.salesforce.com/id/_orgID_/_userID_, where orgId is the ID of the Salesforce org that the user belongs to and userID is the Salesforce user ID.

Identity URL Request Parameters

You can use the following parameters with the access token and identity URL. You can use the access token in an authorization request header or a request with the oauth_token parameter.

Parameter	Description
accesstoken	OAuth token that a connected app uses to request access to a protected resource on behalf of the client application. Additional permissions in the form of scopes can accompany the access token.
format	Optional. Specify the format of the returned output. Values are: `json` `xml` The client can also specify the returned format in an accept-request header using one of the following formats. `Accept: application/json` `Accept: application/xml` `Accept: application/x-www-form-urlencoded` The request header also supports the following. The `/` wildcard is accepted and returns JSON. A list of values, which is checked left to right. For example: `application/xml,application/json,application/html,``/_` returns XML. The `format` parameter takes precedence over the access request header.
version	Optional. Specify a SOAP API version number or the literal string `latest`. If this value isn’t specified, the returned API URLs contain the literal value `{version}` in place of the version number. If the value is specified as `latest`, the most recent API version is used.
PrettyPrint	Optional. Accepted only in a header and not as a URL parameter. Specify this parameter to optimize the returned XML or JSON output for readability rather than size. For example, use the following in a header: `X-PrettyPrint:1`.
callback	Optional. Specify a valid JavaScript function name. You can use this parameter when the specified format is JSON. The output is wrapped in this function name (JSONP). For example, if a request to `https://server/id/orgid/userid/` returns `{“function”:“name”}`, a request to `https://server/id/orgid/userid/?callback=baz` returns `baz({“function”:“name”});`. Note: JSONP is no longer returned for Identity Service requests due to strict MIME typing. Your requests must add `‘format=jsonp’` with the callback parameter so that the Identity Service returns JavaScript. When the Identity Service detects the JSONP format, it returns the required JavaScript type (`‘application/javascript’`).

Identity URL Response

With a successful request, the identity URL response returns information about the queried user and org.

The following identity URL response is in XML format.

1<?xml version="1.0" encoding="UTF-8"?>
2<user xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
3<id>https://MYDOMAINNAME.my.salesforce.com/id/00Dx000.../005x000...</id>
4<asserted_user>true</asserted_user>
5<user_id>005x000000...</user_id>
6<organization_id>00Dx000...</organization_id>
7<nick_name>admin1.2777578168398293E12...</nick_name>
8<display_name>Alan Van</display_name>
9<email>admin@mycompany.com</email>
10<status>
11   <created_date xsi:nil="true"/>
12   <body xsi:nil="true"/>
13</status>
14<photos>
15   <picture>https://MYDOMAINNAME--03925205UAF.file.force-user-content.com</picture>
16   <thumbnail>https://MYDOMAINNAME--03925205UAF.file.force-user-content.com</thumbnail>
17</photos>
18<urls>
19   <enterprise>https://MYDOMAINNAME.my.salesforce.com/services/Soap/c/{version}/00Dx000...</enterprise>
20   <metadata>https://MYDOMAINNAME.my.salesforce.com/services/Soap/m/{version}/00Dx000...</metadata>
21   <partner>https://MYDOMAINNAME.my.salesforce.com/services/Soap/u/{version}/00Dx000...</partner>
22   <rest>https://MYDOMAINNAME.my.salesforce.com/services/data/v{version}/
23   </rest>
24   <sobjects>https://MYDOMAINNAME.my.salesforce.com/services/data/v{version}/sobjects/
25   </sobjects>
26   <search>https://MYDOMAINNAME.my.salesforce.com/services/data/v{version}/search/
27   </search>
28   <query>https://MYDOMAINNAME.my.salesforce.com/services/data/v{version}/query/
29   </query>
30   <profile>https://MYDOMAINNAME.my.salesforce.com/005x000...</profile>
31</urls>
32<active>true</active>
33<user_type>STANDARD</user_type>
34<language>en_US</language>
35<locale>en_US</locale>
36<utcOffset>-28800000</utcOffset>
37<last_modified_date>2021-04-28T20:54:09.000Z</last_modified_date>
38</user>

And this response is in JSON format.

1{"id":"https://MYDOMAINNAME.my.salesforce.com/id/00Dx000.../005x000...",
2"asserted_user":true,
3"user_id":"005x000...",
4"organization_id":"00Dx000...",
5"nick_name":"admin1.2777578168398293E12...",
6"display_name":"Alan Van",
7"email":"admin@mycompany.com",
8"status":{"created_date":null,"body":null},
9"photos":{"picture":"https://MYDOMAINNAME--03925205UAF.file.force-user-content.com",
10   "thumbnail":"https://MYDOMAINNAME--03925205UAF.file.force-user-content.com"},
11"urls":
12   {"enterprise":"https://MYDOMAINNAME.my.salesforce.com/services/Soap/c/{version}/00Dx000...",
13   "metadata":"https://MYDOMAINNAME.my.salesforce.com/services/Soap/m/{version}/00Dx000...",
14   "partner":"https://MYDOMAINNAME.my.salesforce.com/services/Soap/u/{version}/00Dx000...",
15   "rest":"https://MYDOMAINNAME.my.salesforce.com/services/data/v{version}/",
16   "sobjects":"https://MYDOMAINNAME.my.salesforce.com/services/data/v{version}/sobjects/",
17   "search":"https://MYDOMAINNAME.my.salesforce.com/services/data/v{version}/search/",
18   "query":"https://MYDOMAINNAME.my.salesforce.com/services/data/v{version}/query/",
19   "profile":"https://MYDOMAINNAME.my.salesforce.com/005x000..."},
20"active":true,
21"user_type":"STANDARD",
22"language":"en_US",
23"locale":"en_US",
24"utcOffset":-28800000,
25"last_modified_date":"2021-04-28T20:54:09.000+0000"}

This table describes the returned parameters.

Parameter	Description
`id`	Identity URL, which is the same URL that was queried.
`asserted*user`	Boolean value indicating whether the specified access token was issued for this identity.
`user_id`	User ID of the queried user.
`username`	Username of the queried user.
`organization_id`	ID of the queried user’s Salesforce org.
`nick_name`	Experience Cloud nickname of the queried user.
`display_name`	Display name (full name) of the queried user.
`email`	Email address of the queried user.
`email_verified`	Indicates whether the queried user’s email was verified by clicking a link in the “Welcome to Salesforce” email. The email_verified value is set to `true` when users click a link in the email they receive after the following: They change their email address They change their password, or a Salesforce admin resets their password They verify their identity when logging in from a new device or browser A Salesforce admin creates them as a new user For example, a Salesforce admin creates the user Roberta Smith. Roberta receives a “Welcome to Salesforce” email message with a link to verify her account. After she clicks the link, the email_verified value is set to `true`.
`first_name`	First name of the queried user.
`last_name`	Last name of the queried user.
`timezone`	Time zone specified in the queried user’s settings
`photos`	Map of URLs to the queried user’s profile pictures, specified as `picture` or `thumbnail`. Note: Accessing these URLs requires passing an access token. See access token.
`addr_street`	Street specified in the address of the queried user’s settings.
`addr_city`	City specified in the address of the queried user’s settings.
`addr_state`	State specified in the address of the queried user’s settings.
`addr_country`	Country specified in the address of the queried user’s settings.
`addr_zip`	Zip or postal code specified in the address of the queried user’s settings.
`mobile_phone`	Mobile phone number specified in the queried user’s settings.
`mobile_phone_verified`	Queried user confirmed that the mobile phone number is valid,
`status`	Queried user’s current Chatter status. `created_date`—`xsd datetime` value of the creation date of the last post by the user, for example, 2010-05-08T05:17:51.000Z. `body`—Body of the post.
`urls`	Map containing various API endpoints that can be used with the queried user Note: Accessing the REST endpoints requires passing an access token. See access token. `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` Note: If the org doesn’t have a custom domain configured and propagated, this value is omitted.
`active`	Boolean specifying whether the queried user is active.
`user_type`	Type of the queried user.
`language`	Language of the queried user.
`locale`	Locale of the queried user.
`utcOffset`	Offset from UTC of the queried user’s time zone, in milliseconds.
`last_modified_date`	`xsd datetime` format of the last modification of the user, for example, 2010-06-28T20:54:09.000Z.
`is_app_installed`	Value is `true` when the connected app is installed in the user’s org, and the user’s access token was created using an OAuth flow. If the connected app isn’t installed, the response doesn’t contain this value. When parsing the response, check for the existence and value of this property.
`mobile_policy`	Specific values for managing a mobile connected app. These values are available only when the connected app is installed in the current user’s org, the app has a defined session timeout value, and the mobile PIN has a length value defined. `screen_lock`—Length of time to wait to lock the screen after inactivity. `pin_length`—Length of the identification number required to gain access to the mobile app.
`push_service_type`	Set to `apple` if the connected app is registered with Apple Push Notification Service (APNS) for iOS push notifications. Set to `androidGcm` if it’s registered with Google Cloud Messaging (GCM) for Android push notifications. The response value type is an array.
`custom_permissions`	When a request includes the `custom_permissions` scope parameter, the response includes a map containing custom permissions in the org associated with the connected app. If the connected app isn’t installed in the org or has no associated custom permissions, the response doesn’t contain a `custom_permissions` map.

Example

Here’s an example request that includes the custom_permissions scope parameter.

1http://MYDOMAINNAME.my.salesforce.com/services/oauth2/authorize?response_type=token&client*
2                  id=3MVG9lKcPoNINVBKV6EgVJiF.snSDwh6*2wSS7BrOhHGEJkC\*&redirect_uri=http://www.example.org/qa/security/oauth
3                  /useragent_flow_callback.jsp&scope=api%20id%20custom_permissions

Here’s the JSON block in the identity URL response.

1"custom_permissions":
2                     {
3                     "Email.View":true,
4                     "Email.Create":false,
5                     "Email.Delete":false
6                     }

We've Moved

Welcome to the new home of the Mobile SDK Developer Guide! For now, the Japanese guide can be found in PDF form.