Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Koyeb Profile API

The Profile API from Koyeb — 17 operation(s) for profile.

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

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

This API exposes 23 operations across 17 paths, and defines 46 schemas. It is described by OpenAPI 2.0, at version 1.0.0.

Requests are made against the base URL https://app.koyeb.com.

23 operations 17 paths 46 schemas 9 GET3 PATCH9 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
1.0.0
Base URL
https://app.koyeb.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Koyeb Profile API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (Bearer). By default, every request must be authenticated.

Paths & Operations 23

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

Profile 23
GET
/v1/account/idenfy
Begin a session with iDenfy, emit an authToken
GetIdenfyToken → 200400401403404500503default
POST
/v1/account/idenfy
ClearIdenfyVerificationResult marks the current result for idenfy as superseded
ClearIdenfyVerificationResult 1 param → 200400401403404500503default
GET
/v1/account/login_method
Get the login method for an email address
LoginMethod 1 param → 200400401403404500503default
GET
/v1/account/oauth
Get OAuth Providers
GetOAuthOptions 2 params → 200400401403404500503default
POST
/v1/account/oauth
Authenticate using OAuth
OAuthCallback 2 params → 200400401403404500503default
GET
/v1/account/organization
Get Current Organization
GetCurrentOrganization → 200400401403404500503default
GET
/v1/account/organization_invitations
List User Organization Invitations
ListUserOrganizationInvitations 3 params → 200400401403404500503default
GET
/v1/account/organization_invitations/{id}
Get User Organization Invitation
GetUserOrganizationInvitation 1 param → 200400401403404500503default
POST
/v1/account/organization_invitations/{id}/accept
Accept Organization Invitation
AcceptOrganizationInvitation 2 params → 200400401403404500503default
POST
/v1/account/organization_invitations/{id}/decline
Decline Organization Invitation
DeclineOrganizationInvitation 2 params → 200400401403404500503default
GET
/v1/account/organizations
List User Organizations
ListUserOrganizations 5 params → 200400401403404500503default
GET
/v1/account/profile
Get Current User
GetCurrentUser 1 param → 200400401403404500503default
PUT
/v1/account/profile
Update User
UpdateUser 2 params → 200400401403404500503default
PATCH
/v1/account/profile
Update User
UpdateUser2 2 params → 200400401403404500503default
POST
/v1/account/resend_validation
Resend Email Verification
ResendEmailValidation 1 param → 200400401403404500503default
POST
/v1/account/reset_password
Reset Password
ResetPassword 1 param → 200400401403404500503default
GET
/v1/account/settings
GetUserSettings → 200400401403404500503default
PATCH
/v1/account/settings
UpdateUserSettings 1 param → 200400401403404500503default
POST
/v1/account/signup
Signup
Signup 2 params → 200400401403404500503default
POST
/v1/account/update_password
Update Password
UpdatePassword 2 params → 200400401403404500503default
POST
/v1/account/validate/{id}
Validate
Validate 2 params → 200400401403404500503default
PUT
/v2/account/profile
Update User V2
UpdateUserV2 2 params → 200400401403404500503default
PATCH
/v2/account/profile
Update User V2
UpdateUserV22 2 params → 200400401403404500503default

Schemas 46

The contract defines 46 schemas that model the data the API accepts and returns. The most detailed are Organization (31 properties), User (15 properties), OrganizationInvitation (11 properties), PublicUser (6 properties). Each schema is shown below with its type and property counts.

GetOAuthOptionsReply
object
A list of providers which you can use for single sign-on.
1 property
PublicOrganization
object
5 properties
OAuthCallbackRequest
object
4 properties
UserFlags
string
OAuthProvider
object
3 properties
LoginMethodReply.Method
string
ListUserOrganizationsReply
object
4 properties
UserSettings
object
3 properties
ResetPasswordRequest
object
1 property
UpdateUserRequest.UserUpdateBody
object
6 properties
UpdateUserSettingsRequest
object
1 property
PublicUser
object
6 properties
Token
object
4 properties
UserReply
object
1 property
OAuthCallbackReply
object
1 property
UserRole.Role
string
ErrorWithFields
object
4 properties
AcceptOrganizationInvitationReply
object
1 property
ClearIdenfyVerificationResultReply
object
ErrorField
object
2 properties
Plan
string
Error
object
3 properties
OrganizationDetailedStatus
string
GetUserSettingsReply
object
1 property
CreateAccountRequest
object
Create new account
4 properties 2 required
DeclineOrganizationInvitationReply
object
1 property
UpdatePasswordRequest
object
2 properties
google.rpc.Status
object
3 properties
LoginMethodReply
object
1 property
Organization
object
31 properties
ResendEmailValidationRequest
object
UpdateUserSettingsReply
object
1 property
OrganizationInvitation
object
11 properties
Organization.Status
string
User
object
15 properties
OrganizationInvitation.Status
string
ClearIdenfyVerificationResultRequest
object
2 properties
GetIdenfyTokenReply
object
1 property
LoginReply
object
1 property
GetOrganizationReply
object
1 property
GetUserOrganizationInvitationReply
object
1 property
ResendEmailValidationReply
object
Organization.DeactivationReason
string
ResetPasswordReply
object
ListUserOrganizationInvitationsReply
object
4 properties
google.protobuf.Any
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

koyeb-profile-api-openapi.yml Raw ↑

Other APIs Koyeb publishes across the network.

Koyeb activity API
Koyeb Apps API
Koyeb Archives API
Koyeb billing API
Koyeb CatalogDatacenters API
Koyeb CatalogInstances API
Koyeb CatalogInstanceUsage API
Koyeb CatalogRegions API
Koyeb Compose API
Koyeb Coupons API
Koyeb Credentials API
Koyeb Deployments API