How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Platform.sh Users API

The Users API from Platform.sh — 9 operation(s) for users.

This API exposes 10 operations across 9 paths, and defines 9 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against a single base URL, {schemes}://api.upsun.com.

10 operations 9 paths 9 schemas 5 GET1 PATCH4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.upsun.com
Authentication
OAuth 2.0, OAuth 2.0, HTTP Bearer
Contact
Terms of Service
Resource Areas
1

Authentication & Security 3

Platform.sh Users API declares 3 security schemes for authenticating requests. It supports OAuth 2.0 (OAuth2) using the authorizationCode flow. It supports OAuth 2.0 (OAuth2Admin) using the clientCredentials flow, exposing 1 scope. It accepts HTTP bearer tokens (BearerAuth).

Paths & Operations 10

Across 9 paths, the API surfaces 10 operations — 5 GET, 1 PATCH, 4 POST. Each is listed below with its method, path, parameters, and response codes.

Users 10
GET
/medeprecated
Get current logged-in user info
get-current-user-deprecated → 200
POST
/me/phone
Check if phone verification is required
get-current-user-verification-status → 200
POST
/me/verification
Check if verification is required
get-current-user-verification-status-full → 200
GET
/users/me
Get the current user
get-current-user → 200403404
GET
/users/email={email}
Get a user by email
get-user-by-email-address 1 param → 200403404
GET
/users/username={username}
Get a user by username
get-user-by-username 1 param → 200403404
GET
/users/{user_id}
Get a user
get-user 1 param → 200403404
PATCH
/users/{user_id}
Update a user
update-user 1 param body → 200400403
POST
/users/{user_id}/emailaddress
Reset email address
reset-email-address 1 param body → 204400403409
POST
/users/{user_id}/resetpassword
Reset user password
reset-password 1 param → 204403

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are User (16 properties), CurrentUser (15 properties), CurrentUser_3 (13 properties), CurrentUser_2 (13 properties). Each schema is shown below with its type and property counts.

CurrentUser
object
The user object.
15 properties
User
object
16 properties 14 required
Error
object
5 properties
OwnerInfo
object
Project owner information that can be exposed to collaborators.
3 properties
SSHKey
object
The ssh key object.
6 properties
CurrentUser_2
object
The user object.
13 properties
Error_2
object
1 property 1 required
CurrentUser_3
object
The user object.
13 properties
Error_3
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

platform.sh-users-api-openapi.yml Raw ↑
Where this information came from

This is an independent, third-party profile of Platform.sh Users API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.