Retrieve a Forward identity by ID.
GET /api/v1/forward/identities/{identity_id}
Returns an Identity owned by the authenticated account.
Headers
| Header | Required | Description |
|---|---|---|
Authorization | Yes | Bearer <PAT or 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 | End-user ID from the integrator's system. |
name | string | Identity display name. |
identity_type | string | Identity type. A standard Identity returns normal. |
enabled | boolean | Whether the Identity can be used for new operations. |
metadata | object | Custom metadata. |
created_at | string | Creation time in RFC 3339 format. |
updated_at | string | Most recent update time in RFC 3339 format. |
Errors
| HTTP | Type | Code | Trigger |
|---|---|---|---|
| 401 | authentication_error | authentication_required | The PAT or SAT is invalid or expired. |
| 403 | permission_error | - | The caller is not authorized to access this resource. |
| 404 | not_found_error | - | The Identity does not exist or is not visible to the caller. |
Notes
- Disabled identities can still be retrieved.
- Deleted identities must not be used to create new sessions.