Sign in

v1

latestOpenAPI 3.0.2Apache 2.02026-07-1739106293.5 KB
Account Management

Information about the authenticated user

Lists information about the authenticated user such as the user id. The endpoint MAY return the disk quota available to the user. The endpoint MAY also return links related to user management and the user profile, e.g. where payments are handled or the user profile could be edited. For back-ends that involve accounting, this service MAY also return the currently available money or credits in the currency the back-end is working with. This endpoint MAY be extended to fulfil the specification of the OpenID Connect UserInfo Endpoint.

get/me

Response

Information about the logged in user.

user_idstring required

A unique user identifier specific to the back-end, which could either be chosen by a user or is automatically generated by the back-end during the registration process at the back-end. It is meant to be used as an identifier in URIs (e.g. for sharing purposes), which is primarily used in machine-to-machine communication. Preferrably use the human-readable property name to display the user's name in user interfaces instead of the user identifier.

namestring

The user name, a human-friendly displayable name. Could be the user's real name or a nickname.

default_planstring

Name of the single plan the user is currently subscribed to if any.

budgetnumber nullable

The remaining budget a user has available. The value MUST be specified in the currency of the back-end. The value SHOULD be set to null if no explicit limit applies.

Example response

{
  "user_id": "john_doe",
  "default_plan": "free",
  "storage": {
    "free": 536870912,
    "quota": 1073741824
  },
  "links": [
    {
      "href": "https://openeo.example/john_doe/payment/",
      "rel": "payment"
    },
    {
      "href": "https://openeo.example/john_doe/edit/",
      "rel": "edit-form"
    },
    {
      "href": "https://openeo.example/john_doe/",
      "rel": "alternate",
      "type": "text/html",
      "title": "User profile"
    },
    {
      "href": "https://openeo.example/john_doe.vcf",
      "rel": "alternate",
      "type": "text/vcard",
      "title": "vCard of John Doe"
    },
    {
      "href": "https://openeo.example/john_doe/invoices",
      "rel": "related",
      "type": "text/html",
      "title": "Invoices"
    }
  ]
}