--- title: "Information about the authenticated user" method: GET path: "/me" tags: ["Account Management"] --- # Information about the authenticated user `GET /me` 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](http://openid.net/specs/openid-connect-core-1_0.html#UserInfo). ## Response `200` Information about the logged in user. - object — Holds user information. If no budget or storage limit applies to the user account the corresponding properties MUST be set to null. - `user_id` string, 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. - `name` string — The user name, a human-friendly displayable name. Could be the user's real name or a nickname. - `default_plan` string — Name of the single plan the user is currently subscribed to if any. - `storage` object, nullable — Information about the storage space available to the user. - `free` integer, required — Free storage space in bytes, which is still available to the user. Effectively, this is the disk quota minus the used space by the user, e.g. user-uploaded files and job results. - `quota` integer, required — Maximum storage space (disk quota) in bytes available to the user. - `budget` number, 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. - `links` Link[] — Links related to the user profile, e.g. where payments are handled or the user profile could be edited. Providing links with the following `rel` (relation) types is RECOMMENDED: 1. `payment`: A page where users can recharge their user account with money or credits. 2. `edit-form`: Points to a page where the user can edit his user profile. 3. `alternate`: Any other representation of these (and potentially additional) user information, e.g. the (public) user profile page. It is RECOMMENDED to add descriptive titles for a better user experience. 4. `related`: Any other user-specific links to be shown in clients, e.g. to user-specific settings, invoices, etc. It is RECOMMENDED to add descriptive titles for a better user experience. For additional relation types see also the lists of [common relation types in openEO](#section/API-Principles/Web-Linking). - `rel` string, required — Relationship between the current document and the linked document. SHOULD be a [registered link relation type](https://www.iana.org/assignments/link-relations/link-relations.xml) whenever feasible. - `href` string, uri, required — The value MUST be a valid URL. - `type` string — The value MUST be a string that hints at the format used to represent data at the provided URI, preferably a media (MIME) type. - `title` string — Used as a human-readable label for a link. ## Other responses - `4XX` — The request can not be fulfilled due to an error on client-side, i.e. the request is invalid. The client SHOULD NOT repeat the request without modifications. The response body SHOULD contain a JSON error object. MUST be any HTTP status code specified in [RFC 7231](https://www.rfc-editor.org/rfc/rfc7231.html#section-6.6). This request MUST respond with HTTP status codes 401 if authorization is required or 403 if the authorization failed or access is forbidden in general to the authenticated user. HTTP status code 404 SHOULD be used if the value of a path parameter is invalid. See also: * [Error Handling](#section/API-Principles/Error-Handling) in the API in general. * [Common Error Codes](errors.json) - `5XX` — The request can not be fulfilled due to an error at the back-end. The error is never the client’s fault and therefore it is reasonable for the client to retry the exact same request that triggered this response. The response body SHOULD contain a JSON error object. MUST be any HTTP status code specified in [RFC 7231](https://www.rfc-editor.org/rfc/rfc7231.html#section-6.6). See also: * [Error Handling](#section/API-Principles/Error-Handling) in the API in general. * [Common Error Codes](errors.json) --- [API](https://skmtc.net/open-eo/apis/openeo-api.md) · [All operations](https://skmtc.net/open-eo/apis/openeo-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/open-eo/openeo-api/revisions/0c5e31955a19/schema)