sharefile - 如何使用 ShareFile API 创建“客户端用户”？

Question

使用 ShareFile 的 API，我想创建一个“客户端用户”，但现有文档不够详细，无法直接完成任务。

请提供一个示例 HTTP 请求和响应来演示“创建客户端用户”端点的用法。

Answer 1

在发出请求之前，您需要确保已设置关联帐户并且您已获得 oauth2 令牌。如果您使用 ShareFile 帐户登录并访问文档，您可以使用的 oauth2 令牌将显示在页面顶部。

从那里你需要构建你的请求。这是一个示例请求，其中使用星号编辑了一些细节以保护无辜者：

POST /sf/v3/Users HTTP/1.1
Host: **********.sf-api.com
Authorization: Bearer **********
Content-Type: application/json
Cache-Control: no-cache

{"Preferences": {"CanResetPassword": true, "CanViewMySettings": true}, "FirstName": "Billy", "LastName": "Bobby", "Company": "Bobby's World", "Password": "**********", "Email": "**********", "DefaultZone": {"Id": "**********"}}

这是一个示例响应正文：

{
 "Email": "************", 
 "Username": "************", 
 "TotalSharedFiles": 0, 
 "Id": "************", 
 "Contacted": 0, 
 "FirstName": "Billy", 
 "ReferredBy": "************", 
 "IsConfirmed": false, 
 "LastName": "Bobby", 
 "Company": "Bobby's World", 
 "FullNameShort": "B. Bobby", 
 "DateCreated": "2017-02-13T22:19:07.92Z", 
 "odata.metadata": "https://************.sf-api.com/sf/v3/$metadata#Users/ShareFile.Api.Models.User@Element", 
 "url": "https://************.sf-api.com/sf/v3/Users(************)", 
 "Domain": "************", 
 "FullName": "Billy Bobby", 
 "odata.type": "ShareFile.Api.Models.User", 
 "Roles": 
     ["Client", "CanChangePassword", "CanManageMySettings"], 
 "Emails": ["************"]
}

除了响应正文之外，还会有许多标头，根据您的情况可能会有用。特别要注意 Set-Cookie 标头SFAPI_AuthID和SFAPI_SRVNAME。根据文档，您的客户端可以保留这些值，并用于减轻 ShareFile API 服务器上的负载以进行后续 API 调用。