跳转到主要内容
PATCH
cURL
使用此 endpoint 可以让每个应用与其所代表的客户、品牌、环境或内部用例保持一致。 对于经销商而言,此功能允许您重命名或更新每个客户的应用,而无需在客户之间共享凭证。对于直接客户而言,它有助于按产品、地区或环境进行区分,同时将所有内容保留在同一个组织下。
此 endpoint 用于更新应用元数据。除非您另行轮换凭证,否则 api_key 保持不变。

数据位置

应用的数据位置(data_location)在创建应用时选定,之后无法更改:如果更新请求指定的位置与应用现有位置相同,则会被接受;指定任何其他位置则返回 400。 唯一的例外是与您的组织一同创建的生产环境应用,它是在注册时创建的,或通过邮箱验证创建的。只要该应用的所有 API 密钥均未使用过,且没有任何验证会话,第一次指定 data_location 的更新请求即可选定其位置,且仅此一次。控制台中的 为首个应用命名 步骤正是利用此机制来保存您在该步骤中选择的位置。目前唯一可用的位置是 eu,即欧盟(爱尔兰)。

授权

Authorization
string
header
必填

由 POST /programmatic/login/ 或 POST /programmatic/verify-email/ 返回的 RS256 签名 JWT access_token。作为 Authorization: Bearer <access_token> 发送。默认有效期为 86400 秒(24 小时)。该 token 仅对 apx.didit.me/auth/v2 上的账户管理 endpoint 有效。验证 API(verification.didit.me/v3)改用长效的 api_key 作为 x-api-key。

路径参数

org_id
string<uuid>
必填

拥有该应用的组织的 UUID。

示例:

"a1b2c3d4-5678-90ab-cdef-111111111111"

app_id
string<uuid>
必填

要更新的应用的 UUID。

示例:

"b2c3d4e5-6789-01bc-defg-222222222222"

请求体

application/json

仅发送您想要更改的字段。PATCH 语义:缺失的字段将被保留。

应用元数据的 PATCH 请求体。仅发送您想要更改的字段;省略的字段将予以保留。uuid、client_id 和 api_key 无法更新。products 为只读:请求体中的 products 键将被忽略。data_location 在应用创建后无法更改:指定其已有的位置将被接受,指定任何其他位置将返回 400。唯一的例外是随您的组织一同创建的生产环境应用:在尚未使用该应用的任何 API 密钥且其没有任何验证会话时,首次指定 data_location 的更新可以对其进行一次性选择。

name
string

应用显示名称。

示例:

"Acme Production App"

website_url
string

与此应用关联的网站或应用 URL。

示例:

"https://app.acme.example"

redirect_uris
string[]

OAuth 风格及验证重定向流程允许的重定向 URI。

示例:
terms_url
string

在验证流程中显示的服务条款 URL。

privacy_url
string

在验证流程中显示的隐私政策 URL。

description
string

应用的内部描述。

data_location
enum<string>

应用验证数据的存储和处理位置,在创建应用时选择。eu 为欧盟(爱尔兰),即默认值。au(澳大利亚,悉尼)和 mx(墨西哥)即将推出:指定这些位置的请求将返回 400 This data location is not available yet.。组织的沙盒应用始终位于欧盟。

可用选项:
eu,
au,
mx
示例:

"eu"

响应

应用已更新。响应为变更后的完整应用记录,包括 products;uuid、client_id 和 api_key 保持不变。

完整应用记录。uuid、client_id 和 api_key 在创建后永不更改。data_location 同样不会更改,除非在随您的组织创建的生产环境应用被投入使用之前修改一次(参见更新请求)。

uuid
string<uuid>

应用 UUID。在后续调用中用作 {app_id}。

示例:

"b2c3d4e5-6789-01bc-defg-222222222222"

name
string

在 Didit 控制台中显示的应用显示名称。

示例:

"Acme Production App"

client_id
string

公开客户端标识符,可安全嵌入 OAuth 风格的流程中。

示例:

"S9LIYGSoWNuGMLHsvEt9dQ"

api_key
string

长期有效的密钥(也称为 client_secret)。在对 https://verification.didit.me/v3/... 的每次调用(会话、工作流、AML 等)中作为 x-api-key 请求头使用。请妥善作为凭据保管,切勿在客户端暴露。新密钥以 sk_live_(生产环境应用)或 sk_test_(沙盒应用)开头,后接 43 个 URL 安全字符(字母、数字、- 和 _)。在此格式之前创建的密钥没有前缀,仍可继续使用。在恢复账户后的 72 小时内,此处的列表、检索和更新接口将返回空字符串而不是密钥。

示例:

"sk_live_example_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

website_url
string | null

与此应用关联的网站或应用 URL。

示例:

"https://acme.example"

redirect_uris
string[]

OAuth 风格及验证重定向流程允许的重定向 URI。

示例:
terms_url
string | null

在验证流程中显示的服务条款 URL。

示例:

"https://acme.example/terms"

privacy_url
string | null

在验证流程中显示的隐私政策 URL。

示例:

"https://acme.example/privacy"

description
string | null

应用的内部描述(不对终端用户显示)。

created_at
string<date-time>
示例:

"2025-06-01T10:00:00Z"

data_location
enum<string>

应用验证数据的存储和处理位置,在创建应用时选择。eu 为欧盟(爱尔兰),即默认值。au(澳大利亚,悉尼)和 mx(墨西哥)即将推出:指定这些位置的请求将返回 400 This data location is not available yet.。组织的沙盒应用始终位于欧盟。

可用选项:
eu,
au,
mx
示例:

"eu"

products
object[]
read-only

该应用的产品。始终包含全部三项,顺序如下:identity、transactions、authentication。新创建的应用会默认启用 identity 及其所有模块,并禁用 transactions 和 authentication。只读:创建或更新请求体中的 products 键将被忽略。

示例:
最后修改于 2026年11月7日