Enable a Forward Identity.
POST /api/v1/forward/identities/{identity_id}/enable
Headers
| Header | Required | Description |
|---|---|---|
Authorization | Yes | Bearer <PAT or SAT> |
Path parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
identity_id | string | Yes | Forward Identity ID. |
Example response
HTTP 200 OK
Response fields
| Field | Type | Description |
|---|---|---|
id | string | Identity ID. |
enabled | boolean | State after the operation. Always true. |
Errors
| HTTP | Type | Code | Trigger |
|---|---|---|---|
| 401 | authentication_error | authentication_required | The PAT or SAT is invalid, expired, or missing. |
| 404 | not_found_error | - | The Identity does not exist or is not visible to the caller. |
| 409 | conflict_error | ADMIN_IDENTITY_READ_ONLY | The target is the Admin Identity. |