ID を指定して Forward アイデンティティを取得します。
GET /api/v1/forward/identities/{identity_id}
認証されたアカウントが所有する Identity を返します。
Headers
| Header | Required | Description |
|---|---|---|
Authorization | Yes | Bearer <PAT または SAT> |
Path parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
identity_id | string | Yes | Forward Identity ID。 |
Example request
Example response
HTTP 200 OK
Response fields
| Field | Type | Description |
|---|---|---|
id | string | Forward Identity ID。 |
external_id | string | インテグレーターのシステムにおけるエンドユーザー ID。 |
name | string | Identity の表示名。 |
identity_type | string | Identity の種類。通常の Identity は normal を返します。 |
enabled | boolean | Identity を新しい操作に使用できるかどうか。 |
metadata | object | カスタムメタデータ。 |
created_at | string | 作成時刻。RFC 3339 形式。 |
updated_at | string | 最終更新時刻。RFC 3339 形式。 |
Errors
| HTTP | Type | Code | 発生条件 |
|---|---|---|---|
| 401 | authentication_error | authentication_required | PAT または SAT が無効または期限切れです。 |
| 403 | permission_error | - | このリソースへのアクセス権がありません。 |
| 404 | not_found_error | - | Identity が存在しないか、呼び出し元から参照できません。 |
Notes
- 無効化されたアイデンティティも取得できます。
- 削除されたアイデンティティを使用して新しいセッションを作成してはなりません。