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

Upsun MFA API

Multi-factor authentication (MFA) requires the user to present two (or more) types of evidence (or factors) to prove their identity.For example, the evidence might be a password and a device-generated code, which show the user has the knowledge factor ("something you know") as well as the possession factor ("something you have"). In this way MFA offers good protection against the compromise of any single factor, such as a stolen password.Using the MFA API you can set up time-based one-time passcodes (TOTP), which can be generated on a single registered device ("something you have") such as a mobile phone.

Upsun MFA API is one of 50 APIs that Upsun publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include MFA. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 8 operations across 6 paths, and defines 2 schemas. It is described by OpenAPI 3.0.1, at version 1.0.

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

8 operations 6 paths 2 schemas 1 DELETE2 GET5 POST

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 2

Upsun MFA API declares 2 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. By default, every request must be authenticated.

Paths & Operations 8

Across 6 paths, the API surfaces 8 operations — 1 DELETE, 2 GET, 5 POST. Each is listed below with its method, path, parameters, and response codes.

MFA 8

Multi-factor authentication (MFA) requires the user to present two (or more) types of evidence (or factors) to prove their identity. For example, the evidence might be a password…

GET
/users/{user_id}/totp
Get information about TOTP enrollment
get-totp-enrollment 1 param → 200403409
POST
/users/{user_id}/totp
Confirm TOTP enrollment
confirm-totp-enrollment 1 param body → 200400403409
DELETE
/users/{user_id}/totp
Withdraw TOTP enrollment
withdraw-totp-enrollment 1 param → 204403404
POST
/users/{user_id}/codes
Re-create recovery codes
recreate-recovery-codes 1 param → 201403404
GET
/organizations/{organization_id}/mfa-enforcement
Get organization MFA settings
get-org-mfa-enforcement 1 param → 200403
POST
/organizations/{organization_id}/mfa-enforcement/enable
Enable organization MFA enforcement
enable-org-mfa-enforcement 1 param → 204403
POST
/organizations/{organization_id}/mfa-enforcement/disable
Disable organization MFA enforcement
disable-org-mfa-enforcement 1 param → 204403
POST
/organizations/{organization_id}/mfa/remind
Send MFA reminders to organization members
send-org-mfa-reminders 1 param body → 200400403

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are Error (5 properties), OrganizationMFAEnforcement (1 property). Each schema is shown below with its type and property counts.

OrganizationMFAEnforcement
object
The MFA enforcement for the organization.
1 property
Error
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

upsun-mfa-api-openapi.yml Raw ↑

Other APIs Upsun publishes across the network.

Upsun Add-ons API
Upsun Alerts API
Upsun API Tokens API
Upsun Autoscaling API
Upsun Cert Management API
Upsun Connections API
Upsun Deployment API
Upsun Deployment Target API
Upsun Discounts API
Upsun Domain Management API
Upsun Environment Activity API
Upsun Environment API
Where this information came from

This is an independent, third-party profile of Upsun MFA 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.