メインコンテンツへスキップ
POST /api/v1/forward/identities/{identity_id} 変更可能な Identity フィールドを更新します。省略されたフィールドは変更されません。metadata はマージされ、空文字列のメタデータ値はそのキーを削除します。

​
Headers

HeaderRequiredDescription
AuthorizationYesBearer <PAT>
Content-TypeYesapplication/json
Idempotency-KeyNo安全でないリクエストに対する任意のべき等性キー。

​
Path parameters

ParameterTypeRequiredDescription
identity_idstringYesForward Identity ID。

​
Body parameters

ParameterTypeRequiredDescription
external_idstringNo既存のエンドユーザー ID を置き換えます。
namestringNo表示名を置き換えます。
enabledbooleanNoこの Identity を使用できるかどうかを更新します。
metadataobjectNoカスタムメタデータをマージ更新します。空文字列の値はキーを削除します。

​
Example request

curl -s -X POST 'https://api.qoder.com/api/v1/forward/identities/idn_019eabc123' \
  -H "Authorization: Bearer $QODER_PAT" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Example User",
    "enabled": false,
    "metadata": {
      "channel": "app"
    }
  }'

​
Example response

HTTP 200 OK 
{
  "id": "idn_019eabc123",
  "external_id": "user_456",
  "name": "Example User",
  "enabled": false,
  "metadata": {
    "channel": "app"
  },
  "created_at": "2026-06-18T10:00:00Z",
  "updated_at": "2026-06-18T10:30:00Z"
}

​
Response fields

更新された Identity オブジェクトを返します。

​
Errors

HTTPTypeTrigger
400invalid_request_errorリクエストボディが無効です。
401authentication_errorPAT が無効または期限切れです。
404not_found_errorIdentity が存在しません。
409conflict_errorIdentity が既存のレコードと競合しています。

​
Notes

  • enabled=false は、アクティブな Identity を必要とする新しい操作を防ぎます。
  • 過去のセッションおよび監査レコードは変更されません。

アイデンティティを取得する

アイデンティティを削除する