GET /api/v1/forward/identities/{identity_id}/templates
Forward Identity 配下のアクティブまたはアーカイブされた Identity Config レコードを返します。
Headers
| Header | Required | Description |
|---|---|---|
Authorization | Yes | Bearer <PAT> |
Path parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
identity_id | string | Yes | Forward Identity ID。 |
Query parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
template_id | string | No | - | Forward Template ID でフィルタリングします。 |
status | string | No | active | active または archived でフィルタリングします。 |
limit | integer | No | 20 | 1 ページあたりの項目数。最大 100。 |
after_id | string | No | - | 前回のレスポンスの last_id を指すカーソル。before_id と併用できません。 |
before_id | string | No | - | 前回のレスポンスの first_id を指すカーソル。after_id と併用できません。 |
Example request
Example response
HTTP 200 OKResponse fields
| Field | Type | Description |
|---|---|---|
data | array | 現在のページにある Config サマリーオブジェクト。 |
first_id | string|null | このページの最初の config の ID。 |
last_id | string|null | このページの最後の config の ID。 |
has_more | boolean | さらにレコードが残っているかどうか。 |
Errors
| HTTP | Type | Trigger |
|---|---|---|
| 400 | invalid_request_error | ページネーションパラメータが無効です。 |
| 401 | authentication_error | PAT が無効または期限切れです。 |
| 404 | not_found_error | Identity が存在しないか、呼び出し元に表示されません。 |
Notes
- カーソル値は Template ID ではなく Identity Config ID から得られます。
- 1 つの Identity は、指定された Template に対して最大 1 つのアクティブな config を持つことができます。