Koyeb Profile API
The Profile API from Koyeb — 17 operation(s) for profile.
The Profile API from Koyeb — 17 operation(s) for profile.
swagger: '2.0'
info:
title: Koyeb Rest activity Profile API
description: 'The Koyeb API allows you to interact with the Koyeb platform in a simple, programmatic way using conventional HTTP requests.
'
version: 1.0.0
host: app.koyeb.com
schemes:
- https
security:
- Bearer: []
tags:
- name: Profile
paths:
/v1/account/idenfy:
get:
summary: Begin a session with iDenfy, emit an authToken
operationId: GetIdenfyToken
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/GetIdenfyTokenReply'
'400':
description: Validation error
schema:
$ref: '#/definitions/ErrorWithFields'
'401':
description: Returned when the token is not valid.
schema:
$ref: '#/definitions/Error'
'403':
description: Returned when the user does not have permission to access the resource.
schema:
$ref: '#/definitions/Error'
'404':
description: Returned when the resource does not exist.
schema:
$ref: '#/definitions/Error'
'500':
description: Returned in case of server error.
schema:
$ref: '#/definitions/Error'
'503':
description: Service is unavailable.
schema:
$ref: '#/definitions/Error'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/google.rpc.Status'
tags:
- Profile
post:
summary: 'ClearIdenfyVerificationResult marks the current result for idenfy as
superseded'
operationId: ClearIdenfyVerificationResult
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/ClearIdenfyVerificationResultReply'
'400':
description: Validation error
schema:
$ref: '#/definitions/ErrorWithFields'
'401':
description: Returned when the token is not valid.
schema:
$ref: '#/definitions/Error'
'403':
description: Returned when the user does not have permission to access the resource.
schema:
$ref: '#/definitions/Error'
'404':
description: Returned when the resource does not exist.
schema:
$ref: '#/definitions/Error'
'500':
description: Returned in case of server error.
schema:
$ref: '#/definitions/Error'
'503':
description: Service is unavailable.
schema:
$ref: '#/definitions/Error'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/google.rpc.Status'
parameters:
- name: body
in: body
required: true
schema:
$ref: '#/definitions/ClearIdenfyVerificationResultRequest'
tags:
- Profile
/v1/account/login_method:
get:
summary: Get the login method for an email address
operationId: LoginMethod
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/LoginMethodReply'
'400':
description: Validation error
schema:
$ref: '#/definitions/ErrorWithFields'
'401':
description: Returned when the token is not valid.
schema:
$ref: '#/definitions/Error'
'403':
description: Returned when the user does not have permission to access the resource.
schema:
$ref: '#/definitions/Error'
'404':
description: Returned when the resource does not exist.
schema:
$ref: '#/definitions/Error'
'500':
description: Returned in case of server error.
schema:
$ref: '#/definitions/Error'
'503':
description: Service is unavailable.
schema:
$ref: '#/definitions/Error'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/google.rpc.Status'
parameters:
- name: email
in: query
required: false
type: string
tags:
- Profile
/v1/account/oauth:
get:
summary: Get OAuth Providers
operationId: GetOAuthOptions
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/GetOAuthOptionsReply'
'400':
description: Validation error
schema:
$ref: '#/definitions/ErrorWithFields'
'401':
description: Returned when the token is not valid.
schema:
$ref: '#/definitions/Error'
'403':
description: Returned when the user does not have permission to access the resource.
schema:
$ref: '#/definitions/Error'
'404':
description: Returned when the resource does not exist.
schema:
$ref: '#/definitions/Error'
'500':
description: Returned in case of server error.
schema:
$ref: '#/definitions/Error'
'503':
description: Service is unavailable.
schema:
$ref: '#/definitions/Error'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/google.rpc.Status'
parameters:
- name: action
description: Which authentication flow is being initiated
in: query
required: false
type: string
enum:
- signin
- signup
- register
default: signin
- name: metadata
description: 'A small (limited to 400 characters) string of arbitrary metadata which will
be encoded in the state'
in: query
required: false
type: string
tags:
- Profile
post:
summary: Authenticate using OAuth
operationId: OAuthCallback
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/OAuthCallbackReply'
'400':
description: Validation error
schema:
$ref: '#/definitions/ErrorWithFields'
'401':
description: Returned when the token is not valid.
schema:
$ref: '#/definitions/Error'
'403':
description: Returned when the user does not have permission to access the resource.
schema:
$ref: '#/definitions/Error'
'404':
description: Returned when the resource does not exist.
schema:
$ref: '#/definitions/Error'
'500':
description: Returned in case of server error.
schema:
$ref: '#/definitions/Error'
'503':
description: Service is unavailable.
schema:
$ref: '#/definitions/Error'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/google.rpc.Status'
parameters:
- name: body
in: body
required: true
schema:
$ref: '#/definitions/OAuthCallbackRequest'
- name: seon-fp
description: Seon Fingerprint
in: header
required: false
type: string
tags:
- Profile
/v1/account/organization:
get:
summary: Get Current Organization
operationId: GetCurrentOrganization
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/GetOrganizationReply'
'400':
description: Validation error
schema:
$ref: '#/definitions/ErrorWithFields'
'401':
description: Returned when the token is not valid.
schema:
$ref: '#/definitions/Error'
'403':
description: Returned when the user does not have permission to access the resource.
schema:
$ref: '#/definitions/Error'
'404':
description: Returned when the resource does not exist.
schema:
$ref: '#/definitions/Error'
'500':
description: Returned in case of server error.
schema:
$ref: '#/definitions/Error'
'503':
description: Service is unavailable.
schema:
$ref: '#/definitions/Error'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/google.rpc.Status'
tags:
- Profile
/v1/account/organization_invitations:
get:
summary: List User Organization Invitations
operationId: ListUserOrganizationInvitations
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/ListUserOrganizationInvitationsReply'
'400':
description: Validation error
schema:
$ref: '#/definitions/ErrorWithFields'
'401':
description: Returned when the token is not valid.
schema:
$ref: '#/definitions/Error'
'403':
description: Returned when the user does not have permission to access the resource.
schema:
$ref: '#/definitions/Error'
'404':
description: Returned when the resource does not exist.
schema:
$ref: '#/definitions/Error'
'500':
description: Returned in case of server error.
schema:
$ref: '#/definitions/Error'
'503':
description: Service is unavailable.
schema:
$ref: '#/definitions/Error'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/google.rpc.Status'
parameters:
- name: limit
description: (Optional) The number of items to return
in: query
required: false
type: string
- name: offset
description: (Optional) The offset in the list of item to return
in: query
required: false
type: string
- name: statuses
description: (Optional) Filter on organization invitation statuses
in: query
required: false
type: array
items:
type: string
enum:
- INVALID
- PENDING
- ACCEPTED
- REFUSED
- EXPIRED
collectionFormat: multi
tags:
- Profile
/v1/account/organization_invitations/{id}:
get:
summary: Get User Organization Invitation
operationId: GetUserOrganizationInvitation
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/GetUserOrganizationInvitationReply'
'400':
description: Validation error
schema:
$ref: '#/definitions/ErrorWithFields'
'401':
description: Returned when the token is not valid.
schema:
$ref: '#/definitions/Error'
'403':
description: Returned when the user does not have permission to access the resource.
schema:
$ref: '#/definitions/Error'
'404':
description: Returned when the resource does not exist.
schema:
$ref: '#/definitions/Error'
'500':
description: Returned in case of server error.
schema:
$ref: '#/definitions/Error'
'503':
description: Service is unavailable.
schema:
$ref: '#/definitions/Error'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/google.rpc.Status'
parameters:
- name: id
description: The id of the organization invitation to get
in: path
required: true
type: string
tags:
- Profile
/v1/account/organization_invitations/{id}/accept:
post:
summary: Accept Organization Invitation
operationId: AcceptOrganizationInvitation
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/AcceptOrganizationInvitationReply'
'400':
description: Validation error
schema:
$ref: '#/definitions/ErrorWithFields'
'401':
description: Returned when the token is not valid.
schema:
$ref: '#/definitions/Error'
'403':
description: Returned when the user does not have permission to access the resource.
schema:
$ref: '#/definitions/Error'
'404':
description: Returned when the resource does not exist.
schema:
$ref: '#/definitions/Error'
'500':
description: Returned in case of server error.
schema:
$ref: '#/definitions/Error'
'503':
description: Service is unavailable.
schema:
$ref: '#/definitions/Error'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/google.rpc.Status'
parameters:
- name: id
description: The id of the organization invitation to accept
in: path
required: true
type: string
- name: body
in: body
required: true
schema:
type: object
tags:
- Profile
/v1/account/organization_invitations/{id}/decline:
post:
summary: Decline Organization Invitation
operationId: DeclineOrganizationInvitation
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/DeclineOrganizationInvitationReply'
'400':
description: Validation error
schema:
$ref: '#/definitions/ErrorWithFields'
'401':
description: Returned when the token is not valid.
schema:
$ref: '#/definitions/Error'
'403':
description: Returned when the user does not have permission to access the resource.
schema:
$ref: '#/definitions/Error'
'404':
description: Returned when the resource does not exist.
schema:
$ref: '#/definitions/Error'
'500':
description: Returned in case of server error.
schema:
$ref: '#/definitions/Error'
'503':
description: Service is unavailable.
schema:
$ref: '#/definitions/Error'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/google.rpc.Status'
parameters:
- name: id
description: The id of the organization invitation to decline
in: path
required: true
type: string
- name: body
in: body
required: true
schema:
type: object
tags:
- Profile
/v1/account/organizations:
get:
summary: List User Organizations
description: List all organizations that the current user is a member of.
operationId: ListUserOrganizations
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/ListUserOrganizationsReply'
'400':
description: Validation error
schema:
$ref: '#/definitions/ErrorWithFields'
'401':
description: Returned when the token is not valid.
schema:
$ref: '#/definitions/Error'
'403':
description: Returned when the user does not have permission to access the resource.
schema:
$ref: '#/definitions/Error'
'404':
description: Returned when the resource does not exist.
schema:
$ref: '#/definitions/Error'
'500':
description: Returned in case of server error.
schema:
$ref: '#/definitions/Error'
'503':
description: Service is unavailable.
schema:
$ref: '#/definitions/Error'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/google.rpc.Status'
parameters:
- name: limit
description: (Optional) Define pagination limit
in: query
required: false
type: string
- name: offset
description: (Optional) Define pagination offset
in: query
required: false
type: string
- name: order
description: (Optional) Sorts the list in the ascending or the descending order
in: query
required: false
type: string
- name: search
description: '(Optional) Fuzzy case-insensitive search based on organization name or
organization id'
in: query
required: false
type: string
- name: statuses
description: (Optional) Only return organizations which status match one in the list
in: query
required: false
type: array
items:
type: string
enum:
- WARNING
- LOCKED
- ACTIVE
- DEACTIVATING
- DEACTIVATED
- DELETING
- DELETED
collectionFormat: multi
tags:
- Profile
/v1/account/profile:
get:
summary: Get Current User
operationId: GetCurrentUser
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/UserReply'
'400':
description: Validation error
schema:
$ref: '#/definitions/ErrorWithFields'
'401':
description: Returned when the token is not valid.
schema:
$ref: '#/definitions/Error'
'403':
description: Returned when the user does not have permission to access the resource.
schema:
$ref: '#/definitions/Error'
'404':
description: Returned when the resource does not exist.
schema:
$ref: '#/definitions/Error'
'500':
description: Returned in case of server error.
schema:
$ref: '#/definitions/Error'
'503':
description: Service is unavailable.
schema:
$ref: '#/definitions/Error'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/google.rpc.Status'
parameters:
- name: seon-fp
description: Seon Fingerprint
in: header
required: false
type: string
tags:
- Profile
put:
summary: Update User
operationId: UpdateUser
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/UserReply'
'400':
description: Validation error
schema:
$ref: '#/definitions/ErrorWithFields'
'401':
description: Returned when the token is not valid.
schema:
$ref: '#/definitions/Error'
'403':
description: Returned when the user does not have permission to access the resource.
schema:
$ref: '#/definitions/Error'
'404':
description: Returned when the resource does not exist.
schema:
$ref: '#/definitions/Error'
'500':
description: Returned in case of server error.
schema:
$ref: '#/definitions/Error'
'503':
description: Service is unavailable.
schema:
$ref: '#/definitions/Error'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/google.rpc.Status'
parameters:
- name: user
in: body
required: true
schema:
$ref: '#/definitions/UpdateUserRequest.UserUpdateBody'
- name: update_mask
in: query
required: false
type: string
tags:
- Profile
patch:
summary: Update User
operationId: UpdateUser2
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/UserReply'
'400':
description: Validation error
schema:
$ref: '#/definitions/ErrorWithFields'
'401':
description: Returned when the token is not valid.
schema:
$ref: '#/definitions/Error'
'403':
description: Returned when the user does not have permission to access the resource.
schema:
$ref: '#/definitions/Error'
'404':
description: Returned when the resource does not exist.
schema:
$ref: '#/definitions/Error'
'500':
description: Returned in case of server error.
schema:
$ref: '#/definitions/Error'
'503':
description: Service is unavailable.
schema:
$ref: '#/definitions/Error'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/google.rpc.Status'
parameters:
- name: user
in: body
required: true
schema:
$ref: '#/definitions/UpdateUserRequest.UserUpdateBody'
- name: update_mask
in: query
required: false
type: string
tags:
- Profile
/v1/account/resend_validation:
post:
summary: Resend Email Verification
operationId: ResendEmailValidation
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/ResendEmailValidationReply'
'400':
description: Validation error
schema:
$ref: '#/definitions/ErrorWithFields'
'401':
description: Returned when the token is not valid.
schema:
$ref: '#/definitions/Error'
'403':
description: Returned when the user does not have permission to access the resource.
schema:
$ref: '#/definitions/Error'
'404':
description: Returned when the resource does not exist.
schema:
$ref: '#/definitions/Error'
'500':
description: Returned in case of server error.
schema:
$ref: '#/definitions/Error'
'503':
description: Service is unavailable.
schema:
$ref: '#/definitions/Error'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/google.rpc.Status'
parameters:
- name: body
in: body
required: true
schema:
$ref: '#/definitions/ResendEmailValidationRequest'
tags:
- Profile
/v1/account/reset_password:
post:
summary: Reset Password
operationId: ResetPassword
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/ResetPasswordReply'
'400':
description: Validation error
schema:
$ref: '#/definitions/ErrorWithFields'
'401':
description: Returned when the token is not valid.
schema:
$ref: '#/definitions/Error'
'403':
description: Returned when the user does not have permission to access the resource.
schema:
$ref: '#/definitions/Error'
'404':
description: Returned when the resource does not exist.
schema:
$ref: '#/definitions/Error'
'500':
description: Returned in case of server error.
schema:
$ref: '#/definitions/Error'
'503':
description: Service is unavailable.
schema:
$ref: '#/definitions/Error'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/google.rpc.Status'
parameters:
- name: body
in: body
required: true
schema:
$ref: '#/definitions/ResetPasswordRequest'
tags:
- Profile
/v1/account/settings:
get:
operationId: GetUserSettings
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/GetUserSettingsReply'
'400':
description: Validation error
schema:
$ref: '#/definitions/ErrorWithFields'
'401':
description: Returned when the token is not valid.
schema:
$ref: '#/definitions/Error'
'403':
description: Returned when the user does not have permission to access the resource.
schema:
$ref: '#/definitions/Error'
'404':
description: Returned when the resource does not exist.
schema:
$ref: '#/definitions/Error'
'500':
description: Returned in case of server error.
schema:
$ref: '#/definitions/Error'
'503':
description: Service is unavailable.
schema:
$ref: '#/definitions/Error'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/google.rpc.Status'
tags:
- Profile
patch:
operationId: UpdateUserSettings
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/UpdateUserSettingsReply'
'400':
description: Validation error
schema:
$ref: '#/definitions/ErrorWithFields'
'401':
description: Returned when the token is not valid.
schema:
$ref: '#/definitions/Error'
'403':
description: Returned when the user does not have permission to access the resource.
schema:
$ref: '#/definitions/Error'
'404':
description: Returned when the resource does not exist.
schema:
$ref: '#/definitions/Error'
'500':
description: Returned in case of server error.
schema:
$ref: '#/definitions/Error'
'503':
description: Service is unavailable.
schema:
$ref: '#/definitions/Error'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/google.rpc.Status'
parameters:
- name: body
in: body
required: true
schema:
$ref: '#/definitions/UpdateUserSettingsRequest'
tags:
- Profile
/v1/account/signup:
post:
summary: Signup
operationId: Signup
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/LoginReply'
'400':
description: Validation error
schema:
$ref: '#/definitions/ErrorWithFields'
'401':
description: Returned when the token is not valid.
schema:
$ref: '#/definitions/Error'
'403':
description: Returned when the user does not have permission to access the resource.
schema:
$ref: '#/definitions/Error'
'404':
description: Returned when the resource does not exist.
schema:
$ref: '#/definitions/Error'
'500':
description: Returned in case of server error.
schema:
$ref: '#/definitions/Error'
'503':
description: Service is unavailable.
schema:
$ref: '#/definitions/Error'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/google.rpc.Status'
parameters:
- name: body
description: Create new account
in: body
required: true
schema:
$ref: '#/definitions/CreateAccountRequest'
- name: seon-fp
description: Seon Fingerprint
in: header
required: false
type: string
tags:
- Profile
/v1/account/update_password:
post:
summary: Update Password
operationId: UpdatePassword
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/LoginReply'
'400':
description: Validation error
schema:
$ref: '#/definitions/ErrorWithFields'
'401':
description: Returned when the token is not valid.
schema:
$ref: '#/definitions/Error'
'403':
description: Returned when the user does not have permission to access the resource.
schema:
$ref: '#/definitions/Error'
'404':
description: Returned when the resource does not exist.
schema:
$ref: '#/definitions/Error'
'500':
description: Returned in case of server error.
schema:
$ref: '#/definitions/Error'
'503':
description: Service is unavailable.
schema:
$ref: '#/definitions/Error'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/google.rpc.Status'
parameters:
- name: body
in: body
required: true
schema:
$ref: '#/definitions/UpdatePasswordRequest'
- name: seon-fp
description: Seon Fingerprint
in: header
required: false
type: string
tags:
- Profile
/v1/account/validate/{id}:
post:
summary: Validate
operationId: Validate
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/LoginReply'
'400':
description: Validation error
schema:
$ref: '#/definitions/ErrorWithFields'
'401':
description: Returned when the token is not valid.
schema:
$ref: '#/definitions/Error'
'403':
description: Returned when the user does not have permission to access the resource.
schema:
$ref: '#/definitions/Error'
'404':
description: Returned when the resource does not exist.
schema:
$ref: '#/definitions/Error'
'500':
description: Returned in case of server error.
schema:
$ref: '#/definitions/Error'
'503':
description: Service is unavailable.
schema:
$ref: '#/definitions/Error'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/google.rpc.Status'
parameters:
- name: id
in: path
required: true
type: string
- name: seon-fp
description: Seon Fingerprint
in: header
required: false
type: string
tags:
- Profile
/v2/account/profile:
put:
summary: Update User V2
operationId: UpdateUserV2
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/UserReply'
'400':
description: Validation error
schema:
$ref: '#/definitions/ErrorWithFields'
'401':
description: Returned when the token is not valid.
schema:
$ref: '#/definitions/Error'
'403':
description: Returned when the user does not have permission to access the resource.
schema:
$ref: '#/definitions/Error'
'404':
description: Returned when the resource does not exist.
schema:
$ref: '#/definitions/Error'
'500':
description: Returned in case of server error.
schema:
$ref: '#/defini
# --- truncated at 32 KB (47 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/koyeb/refs/heads/main/openapi/koyeb-profile-api-openapi.yml