POST /api/v1/forward/identities
インテグレーターの製品における 1 人のエンドユーザーを表す Identity を作成します。Forward はこの Identity を使用して、セッション、構成、リソース、監査コンテキストのスコープを定めます。
Headers
| Header | Required | Description |
|---|---|---|
Authorization | Yes | Bearer <PAT> |
Content-Type | Yes | application/json |
Idempotency-Key | No | 安全でないリクエストに対する任意のべき等性キー。 |
Body parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
external_id | string | Yes | インテグレーターのシステムにおけるエンドユーザー ID。空文字列や空白のみであってはなりません。 |
name | string | No | 表示名。指定する場合は空文字列や空白のみであってはなりません。 |
enabled | boolean | No | このアイデンティティが使用可能かどうか。デフォルトは true。 |
metadata | object | No | カスタムメタデータ。推奨される最大キー数は 16 です。 |
Example request
Example response
HTTP 201 CreatedResponse fields
| Field | Type | Description |
|---|---|---|
id | string | Forward Identity ID。推奨されるプレフィックスは idn_ です。 |
external_id | string | インテグレーターのシステムにおけるエンドユーザー ID。 |
name | string | 表示名。 |
enabled | boolean | この Identity を新しい操作に使用できるかどうか。 |
metadata | object | カスタムメタデータ。 |
created_at | string | 作成タイムスタンプ。 |
updated_at | string | 更新タイムスタンプ。 |
Errors
| HTTP | Type | Trigger |
|---|---|---|
| 400 | invalid_request_error | external_id、name、またはメタデータが欠落しているか無効です。 |
| 401 | authentication_error | PAT が無効または期限切れです。 |
| 409 | conflict_error | Identity が既存のレコードと競合しています。 |
Notes
- Identity は Qoder のログインアカウントや IAM ユーザーではありません。
- 実際のエンドユーザーの認証はインテグレーターの責任のままです。