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

Spectro Cloud auth API

The auth API from Spectro Cloud — 17 operation(s) for auth.

Spectro Cloud auth API is one of 42 APIs that Spectro Cloud publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 17 operations across 17 paths, and defines 12 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, https://edge-host-ip:5080.

17 operations 17 paths 12 schemas 11 GET2 PATCH4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://api.spectrocloud.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Spectro Cloud auth API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (Authorization).

  • Authorization — JWT authorization token obtained using /v1/users/default/login API

Paths & Operations 17

Across 17 paths, the API surfaces 17 operations — 11 GET, 2 PATCH, 4 POST. Each is listed below with its method, path, parameters, and response codes.

auth 17
POST
/v1/auth/authenticate
Authenticates the user for the specified crendentials
v1Authenticate 1 param body → 200
GET
/v1/auth/mfa/devices
V1AuthMfaDevicesList
V1AuthMfaDevicesList → 200
GET
/v1/auth/org
Returns the user organization details
v1AuthOrg 1 param → 200
GET
/v1/auth/org/{org}/oidc/callback
Idp authorization code callback
V1OidcCallback 5 params → 200
GET
/v1/auth/org/{org}/oidc/logout
Identity provider logout url for the Oidc
V1OidcLogout 2 params → 204
POST
/v1/auth/org/{org}/saml/callback
Identity provider callback url for the SMAL authentication
V1SamlCallback 2 params body → 200
POST
/v1/auth/org/{org}/saml/logout
Identity provider logout url for the SMAL
V1SamlLogout 2 params body → 204
GET
/v1/auth/orgs
Returns a list of user's organizations
V1AuthOrgs → 200
PATCH
/v1/auth/password/{passwordToken}/activate
Updates and Activates the specified user password using the password token
v1PasswordActivate 1 param body → 204
PATCH
/v1/auth/password/{passwordToken}/reset
Resets the user password using the password token
v1PasswordReset 1 param body → 204
GET
/v1/auth/refresh/{token}
Refreshes authentication token
v1AuthRefresh 2 params → 200
GET
/v1/auth/sso/idps
Returns a list of predefined Identity Provider (IDP)
V1SsoIdps → 200
GET
/v1/auth/sso/logins
Returns a list of supported sso logins
V1SsoLogins 1 param → 200
GET
/v1/auth/sso/providers
Returns a list of supported sso auth providers
V1AuthSsoProviders → 200
GET
/v1/auth/sso/{ssoApp}/callback
Returns Authorization token. Works as a callback url for the system defined sso apps
V1SsoCallback 5 params → 200
GET
/v1/auth/user/org/forgot
Returns No Content. Sends the user organization information via email
V1AuthUserOrgForgot 1 param → 204
POST
/v1/auth/user/password/reset
Creates request to reset password via email
v1PasswordResetRequest body → 204

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are v1LoginResponse (8 properties), v1Organization (4 properties), v1SsoLogin (4 properties), v1AuthLogin (3 properties). Each schema is shown below with its type and property counts.

v1LoginResponse
object
Returns the allowed login method and information with the organization details
8 properties
v1MfaDeviceMeta
object
2 properties
v1IdentityProvider
object
Describes a predefined Identity Provider (IDP)
2 properties
v1UserToken
object
Returns the Authorization token. To be used for further api calls
2 properties
v1Organization
object
Describes user's organization details
4 properties
v1Time
string
Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time pack…
v1SsoLogin
object
Describes the allowed sso login details
4 properties
v1IdentityProviders
array
Describes a list of predefined Identity Provider (IDP)
v1SsoLogins
array
Describes the allowed sso logins
v1AuthLogin
object
Describes the credential details required for authentication
3 properties
v1MfaDevices
array
v1Organizations
object
Returns a list of user's organizations details and login methods
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

spectro-cloud-auth-api-openapi.yml Raw ↑

Other APIs Spectro Cloud publishes across the network.

Spectro Cloud activations API
Spectro Cloud apiKeys API
Spectro Cloud appDeployments API
Spectro Cloud appProfiles API
Spectro Cloud audits API
Spectro Cloud cloudaccounts API
Spectro Cloud cloudconfigs API
Spectro Cloud clouds API
Spectro Cloud clustergroups API
Spectro Cloud clusterprofiles API
Spectro Cloud clusterTemplates API
Spectro Cloud dashboard API
Where this information came from

This is an independent, third-party profile of Spectro Cloud auth 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.