Sign-ins and passkeys

Rename a sign-in

Renames an app or a key and returns the sign-in. A key's name is its label. Requires sign_ins.manage.

PATCH
/owner/sign-ins/{id}

Authorization

bearerAuth
headerAuthorizationBearer <token>

Authenticate with an API key (marfa_k1_…) or an OAuth access token (marfa_at_…).

Path parameters

id*string

The ID of the sign-in.

Header parameters

X-Marfa-Instance-Id?string

The ID of the instance you expect, as GET / returns it. If another instance answers at this address, Marfa returns 409 instance_changed and doesn't write. Leave it out to send the request to whichever instance answers.

Match^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

Request body

application/json
  1. body
name*string

The sign-in's new name. Marfa trims spaces from each end.

Length1 <= length <= 200

Response body

About errors

Returns the renamed sign-in.

application/json
  1. response

A sign-in is one way the owner's Marfa can be reached.

id*string

Unique identifier for the sign-in.

kind*string

What signed in. browser: a browser signed in with the owner's password. app: an app the owner approved, for every device it signs in on with that approval. key: an API key.

Value in"browser""app""key"
name*string

A readable name: a browser's from its user_agent, an app's the owner's name for it or else its registered name, a key's its label. A name with a control or bidirectional character, or over 200 characters, gives way to the ID.

created_at*string

When the sign-in was made, in UTC. For an app, when the owner last approved it.

last_used_at*|

When a recorded use occurred, in UTC, or null if none is recorded. Uses are recorded at most once a minute for browsers and once an hour for apps or keys. Failed recording leaves the previous value.

expires_at*|

When the sign-in ends unless used again, in UTC. For an app, the inactivity boundary. null for disabled app inactivity retirement or a key without an expiry.

client_ip*|

The IP address a browser signed in from, or null for an app, a key, or a browser whose address Marfa could not tell.

user_agent*|

The User-Agent a browser sent when it signed in, or null for an app, a key, or a browser that sent none.

minted_by*|

For a key an app minted, the ID of that app's sign-in while the app is signed in. null for a browser, an app, an owner's key (owner_key), any other key, and a key whose app has ended.

  • missing_required_field: name is missing.
  • validation_error: name is empty, too long or holds a control or bidirectional formatting character, the body has another field, or the ID names a browser, whose name comes from the browser.
application/json
  1. response

An error response.

error*

What went wrong.

unauthorized: the request has no credential, or its credential is not valid. For a key that has expired, details.expired_at says when it expired.

application/json
  1. response

An error response.

error*

What went wrong.

  • forbidden: the credential lacks sign_ins.manage. details.required_scope names it.
application/json
  1. response

An error response.

error*

What went wrong.

  • sign_in_not_found: no live sign-in of the owner has this ID. It may have ended or expired.
application/json
  1. response

An error response.

error*

What went wrong.

request_timeout: the request body didn't arrive whole within 180 seconds. Nothing changed, and Marfa closed the connection. Send the request again. A body larger than about 21 MiB can't arrive in that time over a 1 Mbit/s link, so send it in smaller requests.

application/json
  1. response

An error response.

error*

What went wrong.

instance_changed: X-Marfa-Instance-Id names another instance. Nothing is written. Rebuild the working copy from the instance at this address.

application/json
  1. response

An error response.

error*

What went wrong.

contract_mismatch: X-Marfa-Contract names another contract version than this instance speaks, or is not a whole number. Nothing was done.

application/json
  1. response

An error response.

error*

What went wrong.

request_too_large: the request body is larger than this instance accepts.

application/json
  1. response

An error response.

error*

What went wrong.

rate_limited: you sent too many requests. Wait for the number of seconds in Retry-After, then try again.

application/json
  1. response

An error response.

error*

What went wrong.

internal_error: Marfa failed in a way it didn't expect, and the request may not have completed. Read what you changed before you repeat a write.

application/json
  1. response

An error response.

error*

What went wrong.

write_contention: the database was busy, and Marfa couldn't complete the request in time. Nothing changed. Try the request again. While a restore runs, details.reason is restore_running.

application/json
  1. response

An error response.

error*

What went wrong.

insufficient_storage: the disk that holds the instance's data has no room for the request, or the request would leave less free than the instance keeps in reserve. Nothing changed, unless details.write_outcome is unknown, which means the write may have landed: read what you changed before you repeat it. Free space on the disk, then try the request again.

application/json
  1. response

An error response.

error*

What went wrong.

curl -X PATCH 'http://localhost:8600/owner/sign-ins/string' \  -H 'Content-Type: application/json' \  -d '{  "name": "string"}'
About errors
{  "id": "01a1011b-b5e5-7be6-8f3b-77492475b5a4",  "kind": "key",  "name": "CRM sync worker",  "created_at": "2026-10-03T09:35:25.394Z",  "last_used_at": "2026-10-03T09:36:25.084Z",  "expires_at": null,  "client_ip": null,  "user_agent": null,  "minted_by": null}