Owner

Get the owner's profile

Returns the owner's profile fields that your credential can read: name, username, email and avatar, each with its own read permission. A field you can't read is left out, so a credential that can read none gets an empty object.

GET
/profile

Authorization

bearerAuth
headerAuthorizationBearer <token>

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

Response body

About errors

The profile fields you can read.

application/json
  1. response

The owner's profile, as far as your credential can read it.

name?string

The owner's name. Present with profile.name:read.

username?string

The owner's username, which password sign-in matches. Present with profile.username:read.

email?|

The owner's email address, or null when none is set. Present with profile.email:read.

Formatemail
avatar?|

The address of the owner's avatar, or null when there is none. Present with profile.avatar:read. Fetch it with GET /profile/avatar.

Formaturi
  • 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.

The owner is unavailable.

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/profile'
About errors
{  "name": "Alex Example",  "username": "alex",  "email": "alex@example.com",  "avatar": null}