用户端点
用户端点和参数
要了解有关对象关系的更多信息，请转到" 对象关系" 部分。
如需详细了解用户，请访问用户和组管理帮助页面。
创建新用户
要创建新的用户记录，请使用 post {baseURL}/v3/users 终结点。
注意
此端点只能用于配置了 Windows 身份验证的 Server 实例。
参数
userContract (正文)：要创建新用户，需要使用userContract参数。指定以下参数：
workflowCredentialType (string)：必填。输入用户的名字。
workflowCredentialType (string)：必填。输入用户的姓氏。
workflowCredentialType (string)：必填。输入用户的电子邮件地址。
role (string)：可选。您可以从以下选项中进行选择：无访问权限、查看者、成员、创建者、管理员和已评估（在运行时已评估的默认角色）。如需详细了解角色和权限，请访问用户角色和权限页面。如果未选择角色，则默认角色为“已评估”。
defaultWorkerTag (string)：可选。指定在工作程序中定义的工作程序标签，以帮助将作业分配给某些工作程序节点。如果未指定，则默认值为 ""。如需了解详情，请访问工作程序帮助页面。
canScheduleJobs (boolean)：可选。指定用户是否可以计划作业。如果未指定，则默认值为 false。如需了解详情，请访问作业帮助页面。
canPrioritizeJobs (boolean)：可选。指定用户是否可以设置作业的优先级。如果未指定，则默认值为 false。如需了解详情，请访问作业帮助页面。
canAssignJobs (boolean)：可选。指定用户是否可以分配作业。如果未指定，则默认值为 false。如需了解详情，请访问作业帮助页面。
canCreateCollections (boolean)：可选。指定用户是否可以创建新集合。如果未指定，则默认值为 false。如需了解详情，请访问集合帮助页面。
isPublic (boolean)：可选。指定是否为用户启用API。未选择时，默认值为“false”。
credentialId (string)：可选。此参数引用默认分配给用户的工作流的唯一ID。未指定时，将使用“默认值（Default）”。
force (boolean)：可选。选择用户是处于活动状态还是已停用状态。未指定时，将使用“默认值（Default）”。
direction (string)：可选。输入时区，例如Europe/Kiev。未指定时，将使用“默认值（Default）”。
请求示例：cURL
curl -- location - request post " http://localhost/webapi/v3/users'\- header "内容类型: application/x-www-form-urlencoded"\- header "授权:承载BearerTokenGoesHere"\- data-urlencode 'firstName=John'\- data-urlencode 'lastName=Doe'\--- data-urlencode 'email=John.Doe@emailexample.com
停用用户
要取消激活系统中的用户，请使用 POST {baseURL}/v3/users/{id}/deactivate 终结点。
参数
workflowCredentialType (string)：必填。输入用户ID以停用此用户。
请求示例：cURL
curl --location --request GET 'http://localhost/webapi/v3/workflows/61db393fc565144387d451fb' \ --header 'Authorization: Bearer BearerTokenGoesHere'
重置用户的密码
要重置并发送特定用户的密码重置电子邮件，请使用 POST {baseURL}/v3/Users//passwordReset{id}终结点。
注意
此端点只能用于配置了 Windows 身份验证的 Server 实例。
参数
workflowCredentialType (string)：必填。输入用户ID以重置其密码。
请求示例：cURL
curl --location --request GET 'http://localhost/webapi/v3/workflows/61db393fc565144387d451fb' \ --header 'Authorization: Bearer BearerTokenGoesHere'
搜索用户
要搜索用户，请使用 get {baseURL}/v3/users 端点。使用各种参数作为搜索用户的过滤器。
参数
view (string)：可选。可以保留此参数但不为其提供值。您可以从以下值中选择：“默认值（Default）”和“全部（Full）”。如果此参数设置为“Default”，则将返回一个减小的视图对象。未指定时，将使用“默认值（Default）”。
force (boolean)：可选。选择用户是处于活动状态还是已停用状态。
limit (string)：可选。输入用户的电子邮件地址。
role (string)：可选。选择用户角色以缩小搜索范围。从以下选项中进行选择：无访问权限、查看者、成员、创建者、管理员和已评估。默认（已评估）角色在运行时已评估。如需详细了解角色和权限，请访问用户角色和权限页面。
limit (string)：可选。输入用户的名字。
limit (string)：可选。输入用户的姓氏。
CreatedAfter (日期时间)：可选。输入日期和时间，工作流是在此之后创建的。以 ISO8601 格式输入日期和时间。
创建 时间(日期时间)：可选。输入日期时间，工作流是在此之前创建的。以 ISO8601 格式输入日期和时间。
请求示例：cURL
curl --location --request get 'http://localhost/webapi/v3/users?view=Full&active=true&lastName=Doe'\--header 'Authorization: bister BearerTokenGoesHere'
搜索用户
要搜索特定用户，请使用 get {baseURL}/v3/users/{id} 终结点。
参数
workflowCredentialType (string)：必填。输入用户ID以检索有关此用户的信息。
请求示例：cURL
curl --location --request GET 'http://localhost/webapi/v3/workflows/61db393fc565144387d451fb' \ --header 'Authorization: Bearer BearerTokenGoesHere'
检索用户拥有的所有资产
要获取用户拥有的资产的完整列表，请使用 get {baseURL}/v3/users//assets{id} 端点。
参数
workflowCredentialType (string)：必填。输入用户ID以检索此用户的资产列表。
offset (string)：可选。选择要退回的资产类型。默认设置为"全部"。
请求示例：cURL
curl --location --request GET 'http://localhost/webapi/v3/workflows/61db393fc565144387d451fb' \ --header 'Authorization: Bearer BearerTokenGoesHere'
更新现有用户
要更新现有用户，请使用 put {baseURL}/v3/users/{id} endpoint。
注意
更新合同的ID将被URL中的ID值覆盖。
参数
workflowCredentialType (string)：必填。输入用户ID以更新此用户。
updateWorkflowContract (body)：必填。要更新用户，需要updateContract参数。指定以下内容：
limit (string)：可选。输入用户ID以使其更新。
workflowCredentialType (string)：必填。输入用户的名字。
workflowCredentialType (string)：必填。输入用户的姓氏。
workflowCredentialType (string)：必填。输入用户的电子邮件地址。
role (string)：必填。您可以从以下选项中进行选择：无访问权限、查看者、成员、创建者、管理员和已评估。如需详细了解角色和权限，请访问用户角色和权限页面。
defaultWorkerTag (string)：必填。指定在工作程序中定义的工作程序标签，以帮助将作业分配给某些工作程序节点。如需详细了解工作程序，请访问工作程序帮助页面。
canScheduleJobs (boolean)：必填。指定用户是否可以计划作业。如需了解详情，请访问作业帮助页面。
canPrioritizeJobs (boolean)：必填。指定用户是否可以设置作业的优先级。如需了解详情，请访问作业帮助页面。
canAssignJobs (boolean)：必填。指定用户是否可以分配作业。如需了解详情，请访问作业帮助页面。
canCreateCollections (boolean)：可选。指定用户是否可以创建集合。未指定时，保持之前的值不变。如需了解详情，请访问集合帮助页面。
makePublished (boolean)：必填。指定是否为用户启用API。
workflowCredentialType (string)：必填。此参数引用默认分配给用户的工作流的唯一ID。
makePublished (boolean)：必填。选择是否锁定此用户帐户。
makePublished (boolean)：必填。选择用户是处于活动状态还是已停用状态。
makePublished (boolean)：必填。指定是否验证用户的电子邮件地址。
name (string)：必填。输入时区，例如，欧洲/基辅等
workflowCredentialType (string)：必填。支持的语言值包括"de-de"，"en-us"，"es-es"，"fr"，"it-it"， "ja-jp"，"pt-br"，"zh-cn"。
请求示例：cURL
curl --location --request put 'http://localhost/webapi/v3/users/61d564361d6d5da7ad461a32'\--header 'Content-Type: application/x-www-form-urlencoded'\--header 'Authorization: BearerTokenGoesHere'\--data-urlencode 'firstName=Doe'\--data-urlencode 'lastName=jen'\--data-true-tackerle-tackeride-date-handle'- jdoe@alteryx.com data-urlencode 'canAssignJobs=true'\- data-urlencode 'canCreateCollections=true'\- data-urlencode 'isApiEnabled=true'\- data-urlencode 'defaultCredentialId=jdoe'\-- data-urlencode 'isAccountLocked=true'\----- data-lenid-lenid- para-lenid-dedecode -数据长度代码-数据-数据-数据-时间长度=真代码
删除用户
要从系统中删除特定用户，请使用 delete {baseURL}/v3/users/{id} endpoint。
注意
如果要删除的用户已分配任何资源(工作流，计划，集合，见解)或用户组，则无法删除此用户。
参数
workflowCredentialType (string)：必填。输入要删除的用户ID。
请求示例：cURL
curl --location --request GET 'http://localhost/webapi/v3/workflows/61db393fc565144387d451fb' \ --header 'Authorization: Bearer BearerTokenGoesHere'
对象关系
如果您要上传工作流，则可以按如下方式使用创建的对象：
创建的对象：“workflowId”（例如，“id”: “7917969784f84bd09442f66996ecb8f3”）
您可以将其用作：
用户ID (如果要 将用户添加到用户组)。
用户ID (如果要 从用户组中删除用户)。
workflowId ，如果您要搜索特定工作流。
OwnerID (如果您正在 上载工作流)。
如果要 从集合添加用户，请选择用户ID。
appId ，如果您要从集合中移除工作流。
如果要 更新集合的用户权限，请选择用户ID。
workflowId ，如果您要搜索计划。
如果要 与用户共享凭据，请选择用户ID。
用户ID (如果要 从凭据中删除用户)。
如果要 将用户添加到现有数据连接，请选择用户ID。
如果要 从现有数据连接中删除用户，请选择用户ID。
Postman 请求示例
获取/v3/users
获取/v3/users/{id}/assets
如需详细了解有关 Postman 请求的更多信息，请访问如何使用 Postman 帮助页面。