Skip to main content

凭证端点

凭证端点和参数

要详细了解对象关系以及如何在 API 中使用对象关系,请参阅 对象关系 部分。

如需详细了解凭证,请访问 凭证 帮助页面。

注意

我们不允许通过 API 创建凭证。要以管理员身份创建凭证,请使用 Server UI

检索一条凭证记录

要获取有关所有工作流记录的信息,请使用 GET {baseURL}/v3/workflows/ 端点。

参数

  • view  (string):可选。可以保留此参数但不为其提供值。您可以从以下值中选择:“默认值(Default)”和“全部(Full)”。如果此参数设置为“Default”,则将返回一个减小的视图对象。未指定时,将使用“默认值(Default)”。

  • ownerId  (string):可选。要按用户ID筛选结果,请输入用户的ID。

  • versionId  (string):可选。要按用户组ID筛选结果,请输入用户组的ID。

检索一条凭证记录

要检索有关凭据的信息,请使用 get {baseURL}/v3/credentials/{credentialId} 端点。

参数

  • workflowCredentialType (string):必填。输入集合 ID以获取有关特定凭据的信息。

与用户共享凭证

要与用户共享凭据,请使用 post {baseURL} /v3/credentials//users{credentialId} 端点。

参数

  • workflowCredentialType (string):必填。输入要共享的集合 ID。

  • 合同 (主体):必填。指定以下内容以与用户共享凭据:

    • workflowCredentialType (string):必填。指定要与其共享凭据的用户的ID。

与用户组共享凭证

要与用户组共享凭据,请使用 post {baseURL} /v3/credentials//usersgroups{credentialId} 终结点。

参数

  • workflowCredentialType (string):必填。输入要共享的凭据ID。

  • 合同 (主体):必填。指定以下选项以与用户组共享凭据:

    • workflowCredentialType (string):必填。指定要与其共享凭据的用户组的ID。

从凭证中移除用户

要从凭据中删除用户,请使用 delete {baseURL}/v3/credentials//users/{credentialId}{userId} endpoint。

参数

  • workflowCredentialType (string):必填。输入要为其检索信息的的工作流 ID。

  • workflowCredentialType (string):必填。输入要从凭据中删除的用户ID。

从集合中移除用户或用户组

要从凭据中删除用户组,请使用 delete {baseURL}/v3/credentials//usergroups/{credentialId}{userGroupId} Endpoint。

参数

  • workflowCredentialType (string):必填。输入要从中删除用户组的凭据ID。

  • workflowCredentialType (string):必填。输入要从凭据中删除的用户组ID。

删除凭证

要删除凭据,请使用 delete {baseURL}/v3/credentials/{credentialId} endpoint。

参数

  • workflowCredentialType (string):必填。选择要删除的凭证。

  • force  (boolean):可选。选择是否要在存在任何共享时强制删除凭据。如果要删除凭据并清除所有共享,请将force参数设置为true。未选择时,默认值为“false”。这是为了防止错误的调用。

对象关系

要获取有关现有凭据ID的信息,请使用 get /v3/credentials端点 在以下情况下可以使用您获得的凭证ID: