Plugins

Start a connector's sign-in

Starts a sign-in to the provider a plugin's connector declares, and returns the address to open in the owner's browser. The provider sends the browser back to Marfa, which seals the refresh token into the connector's token setting.

POST
/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.

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

Where the browser goes once the sign-in finishes. Send {} to show a page instead.

return_to?string

A path, or an address on this instance's sign-in address, to send the browser to once the sign-in finishes, with signed_in added to its query. An app's own OAuth access token can also name one of the redirect URIs its client registered, exactly as registered, such as a native app's private-use scheme. Leave it out to show a page instead.

Length1 <= length <= 2048

Response body

About errors

Returns the address to open in the owner's browser and when the sign-in ends.

application/json
  1. response

A sign-in started for a plugin's connector.

id*string

The sign-in's ID, which GET /plugins/{name}/connector/sign-in returns while this sign-in is the latest, so you can tell it from one a later start replaced it with.

url*string

The provider's address to open in the owner's browser. Its query carries the client ID, the address the provider sends the browser back to, the scopes, a state and a PKCE challenge.

Formaturi
expires_at*string

When the sign-in ends if the owner's browser hasn't come back, in UTC: ten minutes after the start.

Formatdate-time
  • validation_error: the body isn't a JSON object, names a field other than return_to, or gives a return_to that isn't a path, an address on this instance's sign-in address, or a redirect URI the calling app registered; details.errors names return_to. 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.

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.

  • connector_sign_in_not_declared: the plugin's connector declares no sign_in.
  • connector_sign_in_settings_missing: the client ID or client secret setting holds no value Marfa can read; details.settings names each.
  • instance_changed: X-Marfa-Instance-Id names another instance. Nothing is written.
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 POST 'http://localhost:8600/plugins/string/connector/sign-in' \  -H 'Content-Type: application/json' \  -d '{  "return_to": "/done"}'
About errors
{  "id": "019a8b4e-7c2d-7f3a-9b1e-4d5c6a7b8c9d",  "url": "https://accounts.google.com/o/oauth2/v2/auth?client_id=example.apps.googleusercontent.com&redirect_uri=https%3A%2F%2Fmarfa.example.com%2Fconnect%2Foauth%2Fcallback&response_type=code&scope=https%3A%2F%2Fwww.googleapis.com%2Fauth%2Fdrive.readonly&state=8kq2nXbL0wQf3vTzR1yHcA9mJ5sE7uPd4gN6iKoWlMv&code_challenge=E9Melhoa2OwvFrEMTJguCHaoeK1t8URWbuGJSstw-cM&code_challenge_method=S256&access_type=offline&prompt=consent",  "expires_at": "2026-11-22T09:40:00.000Z"}