Loading
识别您的用户并管理访问
目录
选择筛选器

          没有结果
          没有结果
          以下是一些搜索提示

          检查关键字的拼写。
          使用更普遍的搜索词。
          选择更少的筛选器,并扩大搜索范围。

          搜索所有 Salesforce 帮助
          用户信息查询

          用户信息查询

          连接的应用程序可以向 UserInfo 端点查询与连接的应用程序的访问标记相关联的用户的信息。Salesforce 返回关于用户的基本个人信息,以及连接的应用程序可与其对话的重要端点,如用户的照片和其可访问的 API 端点。此用户信息端点仅为当前用户提供信息的访问权限。不会为组织中的内容用户授予访问权限。

          所需的 Edition

          适用于 Salesforce Classic 和 Lightning Experience
          适用于:所有版本

          UserInfo 端点是一个由 OpenID Connect 定义的 RESTful API。端点 URL 的格式是:https://login.salesforce.com/services/oauth2/userinfo

          备注
          备注 对于 sandbox,使用 test.salesforce.com 替代 login.salesforce.com。对于 Experience Cloud 站点,使用站点 URL 替换 login.salesforce.com,例如 MyDomainName.my.site.com/.well-known/openid-configuration.。URL 必须是 HTTPS。

          下面是查询 UserInfo 端点的流程。

          1. 连接的应用程序向 Salesforce UserInfo 端点发送查询。查询必须包含连接的应用程序的访问标记。
          2. Salesforce 以用户信息作为回应。

          查询 UserInfo 端点

          使用这些参数查询 UserInfo 端点。您可以在授权请求标题或带有 oauth_token 参数的请求中使用访问令牌。

          重要
          重要 在开发 OAuth 集成时,请始终在 POST 请求的正文或请求标题中传递敏感信息。不要在 URL 查询字符串中使用 GET 参数来传递敏感信息。敏感信息包括但不限于用户名、密码、OAuth 令牌、客户端密码和任何个人身份信息。有关安全最佳实践的更多信息,请查看安全编码指南中的存储敏感数据
          参数 描述
          oauth_token 连接的应用程序用来代表客户端应用程序请求访问受保护资源的 OAuth 标记。访问标记可以附带范围形式的附加权限。
          格式

          可选。指定返回输出的格式。值是:

          • json
          • xml

          客户端还可以使用以下格式之一在接受请求头中指定返回的格式。

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

          请求头还支持以下内容。

          • 接受*/*通配符并返回 JSON。
          • 从左向右检查的值列表。例如:application/xml,application/json,application/html,*/* 返回 XML。

          format 参数优先于访问请求标题。

          version 可选。指定 SOAP API 版本号或文字字符串latest。如果未指定此值,则返回的 API URL 包含文字值 {version},以代替版本号。如果值指定为 latest,则使用最新的 API 版本。
          PrettyPrint 可选。仅在标题中接受,不作为 URL 参数接受。指定该参数,以按照可读性而不是大小,优化返回的 XML 或 JSON 输出。例如,在标题中使用以下:X-PrettyPrint:1.
          回调

          可选。指定有效的 JavaScript 函数名称。您可在指定格式是 JSON 时使用此参数。在此函数名称中输出被换行 (JSONP)。例如,如果对 https://server/id/orgid/userid/ 的请求返回 {"function":"name"},对 https://server/id/orgid/userid/?callback=baz 的请求将返回 baz({"function":"name"});

          备注
          备注 不会再为身份服务请求返回 JSONP,因为严格的 MIME 键入。您的请求必须添加带有回调参数的'format=jsonp',以便身份服务返回 JavaScript。当身份服务检测到 JSONP 格式时,它会返回所需的 JavaScript 类型 ('application/javascript')。
          is_salesforce_ integration_user 可选。指定此参数,以确定用户是否拥有 Salesforce 集成用户许可证。

          Salesforce UserInfo 端点响应

          默认情况下,在进行了有效的请求后,Salesforce 会返回 JSON 格式的信息,或返回格式参数中指定的格式。

          响应包含 OpenID Connect 基本客户端简档中列出的值、Salesforce 用户 ID、组织 Id、摘要和简档 URL。

          在响应中,email_verified 属性反映了发生以下情况后,用户是否验证了他们的电子邮件:例如,Salesforce 管理员创建用户 Roberta Smith。Roberta 会收到一封“欢迎使用 Salesforce”的电子邮件,并附带一个链接来验证她的账户。单击链接后,email_verified 值设置为 true

          • 更改他们的电子邮件
          • 更改他们的密码,或者 Salesforce 管理员重置密码
          • 当从新设备或浏览器登录时,他们验证自己的身份
          • Salesforce 管理员将其创建为新用户

          以下是 JSON 格式的响应。

          {"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"}

          以下是 XML 格式的响应。

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

          以下是返回的参数的描述。

          参数 描述
          sub UserInfo 端点的 URL,与查询的 URL 相同。
          user_id 所查询用户的用户 ID。
          organization_id 所查询用户的 Salesforce 组织的 ID。
          preferred_username 所查询用户的用户名。
          nickname 所查询用户的 Experience Cloud 昵称。
          name 所查询用户的显示名(全名)。
          email 所查询用户的电子邮件地址。
          email_verified

          指示是否通过单击“欢迎使用 Salesforce”电子邮件中的链接来验证所查询用户的电子邮件。

          出现以下情况后,当用户单击收到的电子邮件中的链接时,email_verified 值设置为 true:例如,Salesforce 管理员创建用户 Roberta Smith。Roberta 会收到一封“欢迎使用 Salesforce”的电子邮件,并附带一个链接来验证她的账户。单击链接后,email_verified 值设置为 true

          • 更改他们的电子邮件
          • 更改他们的密码,或者 Salesforce 管理员重置密码
          • 当从新设备或浏览器登录时,他们验证自己的身份
          • Salesforce 管理员将其创建为新用户
          given_name 所查询用户的名字。
          family_name 所查询用户的姓氏。
          zoneinfo 所查询用户的设置中指定的时区
          photos

          URL 到所查询用户的简档图片的映射,指定为picturethumbnailprofile

          备注
          备注 访问这些 URL 需要传递访问标记。
          address 所查询用户的地址,可以包括用户的街道、城市、州/省、国家/地区和邮政编码。
          mobile_phone 在所查询用户的设置中指定的手机号码。
          mobile_phone_verified 所查询用户确认手机号码有效。
          urls

          包含可用于所查询用户的各个 API 端点的映射

          备注
          备注 访问 REST 端点需要传递访问标记。
          • 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

            如果组织未配置和传播自定义域,则忽略此值。

          active 布尔值,指定所查询用户是否已启用。
          user_type 所查询用户的类型。
          language 所查询用户的语言。
          locale 所查询用户的区域设置。
          utcOffset 所查询用户的时区与世界协调时的偏移量,以毫秒为单位。
          updated_at 用户上次修改的xsd datetime格式,例如 2010-06-28T20:54:09.000Z。
          is_app_installed 该值是连接的应用程序安装在用户组织中并使用 OAuth 流创建用户访问令牌时的true。如果未安装连接的应用程序,则响应不包含此值。解析响应时,检查此属性是否存在并检查其值。
          mobile_policy

          用于管理移动连接的应用程序的特定值。这些值仅在连接的应用程序安装到当前用户的组织、应用程序有定义的会话超时值以及移动 PIN 具有长度值时可用。

          • screen_lock— 不活动后等待锁定屏幕的时间长度。
          • pin_length — 访问移动应用程序所需的识别号长度。
          push_service_type

          如果连接的应用程序已向 iOS 推送通知的 Apple 推送通知服务 (APNS) 注册,设置为 apple。如果使用 Google Cloud Messaging (GCM) 注册 Android 推送通知,设置为 androidGcm

          该响应值类型为数组。

          custom_permissions

          当请求包含 custom_permissions 范围参数时,响应包含映射,该映射包含与连接的应用程序相关联的组织中的自定义权限。如果连接的应用程序未安装在组织中,或没有关联的自定义权限,则响应不包含custom_permissions映射。

          此处是示例请求。

          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
                   

          此处是身份 URL 响应中的 JSON 块。

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

          以下是 Salesforce 对无效请求可能做出的响应。

          错误代码 请求问题
          403(禁止) — HTTPS_Required HTTP
          403(禁止) — Missing_OAuth_Token 缺少访问标记
          403(禁止) — Bad_OAuth_Token 无效访问标记
          403(禁止) — Wrong_Org 用户在不同的组织中
          404(找不到) — Bad_Id 无效或错误用户或组织 ID
          404(找不到) — 无效 禁用用户或无效组织
          404(找不到) — No_Access 用户缺少对组织或信息的访问权限
          404(找不到) — No_Site_Endpoint 对站点无效端点的请求
          404(找不到)— 内部错误 服务器未响应
          406(不可接受) — Invalid_Version 无效版本
          406(不可接受) — Invalid_Callback 无效回调
           
          正在加载
          Salesforce Help | Article