Update an Actor

Updates an Actor.

Warning: changing an Actor's email signs them out and unlinks their identity providers.

If the email field is changed to a different address, Firezone will:

Unlink every identity provider (Google, Okta, Entra, etc.) connected to this Actor.
End all active sessions for this Actor, both in the admin portal and on connected Client devices. The user will be signed out immediately.

The Actor will need to sign in again through their identity provider, which re-links it under the new email.

Email comparison ignores case and surrounding whitespace, so changes like User@Example.com → user@example.com are not treated as a real change and will not unlink identities.

Setting is_disabled to true immediately revokes all of the Actor's active Client tokens and portal sessions. An Actor cannot disable itself.

put/actors/{id}

Path parameters

idstring required

Actor ID

Request body

Example request

{
  "actor": {
    "allow_email_otp_sign_in": false,
    "email": "joe.user@example.com",
    "is_disabled": false,
    "name": "Joe User",
    "type": "account_admin_user"
  }
}

Response

ActorResponse

Example response

{
  "data": {
    "allow_email_otp_sign_in": false,
    "created_by_directory_id": null,
    "email": "john.doe@example.com",
    "id": "42a7f82f-831a-4a9d-8f17-c66c2bb6e205",
    "inserted_at": "2024-01-01T00:00:00Z",
    "is_disabled": false,
    "last_seen_at": "2024-01-15T10:30:00Z",
    "name": "John Doe",
    "type": "account_admin_user",
    "updated_at": "2024-01-15T10:30:00Z"
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.