Plugins

Get a connector's sign-in

Returns the status of the latest sign-in started for a plugin's connector, so you can tell when the owner's browser finished it.

GET
/plugins/{name}/connector/sign-in

Authorization

bearerAuth
headerAuthorizationBearer <token>

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

Path parameters

name*string

The plugin's name.

Response body

About errors

Returns the status of the latest sign-in.

application/json
  1. response

The latest sign-in started for a plugin's connector.

plugin*string

The plugin's name.

status*string

Where the latest sign-in stands: none if none was started, pending while it waits for the owner's browser, signed_in once Marfa stored the refresh token, failed once it ended any other way, and expired once ten minutes passed.

Value in"none""pending""signed_in""failed""expired"
reason*|

Why the latest sign-in failed, or null unless status is failed: an RFC 6749 error such as invalid_client (a wrong client ID or secret) or access_denied, or a word of Marfa's such as timeout or status_503. Never the provider's text.

id*|

The latest sign-in's ID, as its start returned it, or null if none was started.

started_at*|

When the latest sign-in started, in UTC, or null if none was started.

Formatdate-time
expires_at*|

When the latest sign-in ends if the owner's browser doesn't come back, in UTC, or null if none was started.

Formatdate-time
ended_at*|

When the owner's browser came back and ended the latest sign-in, in UTC, or null while it is pending, once it expired, or if none was started.

Formatdate-time
  • validation_error: the query has a parameter this endpoint doesn't take.
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: you lack connectors.manage.
application/json
  1. response

An error response.

error*

What went wrong.

  • plugin_not_found: no plugin of this name is installed.
  • connector_not_found: the plugin has no connector.
application/json
  1. response

An error response.

error*

What went wrong.

  • connector_sign_in_not_declared: the plugin's connector declares no sign_in.
  • instance_changed: X-Marfa-Instance-Id names another instance. 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.

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 GET 'http://localhost:8600/plugins/string/connector/sign-in'
About errors
{  "plugin": "google-drive",  "status": "signed_in",  "reason": null,  "id": "019a8b4e-7c2d-7f3a-9b1e-4d5c6a7b8c9d",  "started_at": "2026-11-22T09:30:00.000Z",  "expires_at": "2026-11-22T09:40:00.000Z",  "ended_at": "2026-11-22T09:31:12.000Z"}