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: '#/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 V2
      operationId: UpdateUserV22
      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
definitions:
  GetOAuthOptionsReply:
    type: object
    properties:
      oauth_providers:
        type: array
        items:
          $ref: '#/definitions/OAuthProvider'
    description: A list of providers which you can use for single sign-on.
  PublicOrganization:
    type: object
    properties:
      id:
        type: string
      name:
        type: string
      plan:
        $ref: '#/definitions/Plan'
      status:
        $ref: '#/definitions/Organization.Status'
      external_id:
        type: string
  OAuthCallbackRequest:
    type: object
    properties:
      state:
        type: string
        title: The state created at the origin of the OAuth flow
      code:
        type: string
        title: The code returned by the OAuth provider
      setup_action:
        type: string
        description: 'setup_action is populated in the context of a GitHub app installation

          request. For logins and signups, it is not set.'
      installation_id:
        type: string
        description: 'installation_id is populated in the context of a GitHub app installation

          request. For logins and signups, it is not set.'
  UserFlags:
    type: string
    enum:
    - ADMIN
    - TEST
    - RESTRICTED
    - ACTIVE
    - BETA
    - MAX_ORGANIZATIONS_25
    - MAX_ORGANIZATIONS_100
    - MAX_ORGANIZATIONS_1000
    - MAX_ORGANIZATIONS_10000
    - MAX_ORGANIZATIONS_100000
    - MAX_ORGANIZATIONS_1000000
    - PARTNER_CSP
    - IGNORE_ORGANIZATION_NAME_RESERVATION_RULE_NEON_PREFIX
    default: ADMIN
    title: "- ADMIN: A user is an admin user\n - TEST: A user is a test user\n - RESTRICTED: Whether this account as restricted access\n - ACTIVE: Whether this account is active\n - BETA: Account in beta program\n - MAX_ORGANIZATIONS_25: User can create this much organizations, overriding the default amount\n - PARTNER_CSP: User can create sub-organizations\n - IGNORE_ORGANIZATION_NAME_RESERVATION_RULE_NEON_PREFIX: User can bypass organization name reservations rules"
  OAuthProvider:
    type: object
    properties:
      id:
        type: string
        title: The name of the provider (.e.g github, google)
      url:
        type: string
        title: The URL to call to initiate the OAuth flow
      state:
        type: string
        title: 'The OAuth state required by the protocol, it is only valid 10 minutes and

          encodes information about the type of flow'
  LoginMethodReply.Method:
    type: string
    enum:
    - KOYEB
    - WORKOS
    default: KOYEB
  ListUserOrganizationsReply:
    type: object
    properties:
      organizations:
        type: array
        items:
          $ref: '#/definitions/Organization'
        title: The collection of organizations
      limit:
        type: integer
        format: int64
        title: The limit in the request
      offset:
        type: integer
        format: int64
        title: The offset in the request
      has_next:
        type: boolean
        title: If there is more items after in the collection
  UserSettings:
    type: object
    properties:
      id:
        type: string
      user_id:
        type: string
      failed_deployment_email_notification:
        type: boolean
  ResetPasswordRequest:
    type: object
    example:
      email: john@snow.com
    properties:
      email:
        type: string
  UpdateUserRequest.UserUpdateBody:
    type: object
    properties:
      id:
        type: string
      email:
        type: string
      current_password:
        type: string
      password:
        type: string
      newsletter_subscribed:
        type: boolean
      name:
        type: string
  UpdateUserSettingsRequest:
    type: object
    properties:
      failed_deployment_email_notification:
        type: boolean
        description: (Optional) Toggle failed deployment email notification.
  PublicUser:
    type: object
    properties:
      id:
        type: string
      email:
        type: string
      name:
        type: string
      avatar_url:
        type: string
      github_id:
        type: string
      github_user:
        type: string
  Token:
    type: object
    example:
      id: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
      expires: '2022-09-08T14:00:00Z'
      user_id: 996d7822-6b58-11e9-956f-32001b70f000
      organization_id: 9f33b2c6-6b58-11e9-883c-32001b70f000
    properties:
      id:
        type: string
      user_id:
        type: string
      organization_id:
        type: string
      expires_at:
        type: string
        format: date-time
  UserReply:
    type: object
    properties:
      user:
        $ref: '#/definitions/User'
  OAuthCallbackReply:
    type: object
    properties:
      token:
        $ref: '#/definitions/Token'
        title: A jwt token to be used for session
  UserRole.Role:
    type: string
    enum:
    - INVALID
    - OWNER
    default: INVALID
  ErrorWithFields:
    type: object
    properties:
      status:
        type: integer
        format: int32
      code:
        type: string
      message:
        type: string
      fields:
        type: array
        items:
          $ref: '#/definitions/ErrorField'
  AcceptOrganizationInvitationReply:
    type: object
    properties:
      invitation:
        $ref: '#/definitions/OrganizationInvitation'
        title: The organization invitation accepted
  ClearIdenfyVerificationResultReply:
    type: object
  ErrorField:
    type: object
    properties:
      field:
        type: string
      description:
        type: string
  Plan:
    type: string
    enum:
    - hobby
    - starter
    - startup
    - business
    - enterprise
    - internal
    - hobby23
    - no_plan
    - pro
    - scale
    - partner_csp
    - partner_csp_unit
    default: hobby
  Error:
    type: object
    properties:
      status:
        type: integer
        format: int32
      code:
        type: string
      message:
        type: string
  OrganizationDetailedStatus:
    type: string
    enum:
    - NEW
    - EMAIL_NOT_VALIDATED
    - BILLING_INFO_MISSING
    - LOCKED
    - PAYMENT_FAILURE
    - VALID
    - PENDING_VERIFICATION
    - VERIFICATION_FAILED
    - REVIEWING_ACCOUNT
    - PLAN_UPGRADE_REQUIRED
    default: NEW
  GetUserSettingsReply:
    type: object
    properties:
      settings:
        $ref: '#/definitions/UserSettings'
  CreateAccountRequest:
    type: object
    example:
      email: john@snow.com
      password: '...'
    properties:
      email:
        type: string
      password:
        type: string
      name:
        type: string
      captcha:
        type: string
    description: Create new account
    title: Create new account
    required:
    - email
    - password
  DeclineOrganizationInvitationReply:
    type: object
    properties:
      invitation:
        $ref: '#/definitions/OrganizationInvitation'
        title: The organization invitation declined
  UpdatePasswordRequest:
    type: object
    example:
      id: '...'
      password: '...'
    properties:
      id:
        type: string
      password:
        type: string
  google.rpc.Status:
    type: object
    properties:
      code:
        type: integer
        format: int32
      message:
        type: string
      details:
        type: array
        items:
          $ref: '#/definitions/google.protobuf.Any'
  LoginMethodReply:
    type: object
    properties:
      method:
        $ref: '#/definitions/LoginMethodReply.Method'
  Organization:
    type: object
    properties:
      id:
        type: string
      external_id:
        type: string
      provisioning:
        type: boolean
      address1:
        type: string
      address2:
        type: string
      city:
        type: string
      postal_code:
        type: string
      state:
        type: string
      country:
        type: string
      company:
        type: boolean
      vat_number:
        type: string
      billing_name:
        type: string
      billing_email:
        type: string
      name:
        type: string
      plan:
        $ref: '#/definitions/Plan'
      plan_updated_at:
        type: string
        format: date-time
      has_payment_method:
        type: boolean
      subscription_id:
        type: string
      current_subscription_id:
        type: string
      latest_subscription_id:
        type: string
      signup_qualification:
        type: object
      status:
        $ref: '#/definitions/Organization.Status'
      status_message:
        $ref: '#/definitions/OrganizationDetailedStatus'
      deactivation_reason:
        $ref: '#/definitions/Organization.DeactivationReason'
      verified:
        type: boolean
      qualifies_for_hobby23:
        type: boolean
      reprocess_after:
        type: string
        format: date-time
      trialing:
        type: boolean
      trial_starts_at:
        type: string
        format: date-time
      trial_ends_at:
        type: string
        format: date-time
      email_domain_allowlist:
        type: array
        items:
          type: string
    title: Represent an Organization
  ResendEmailValidationRequest:
    type: object
  UpdateUserSettingsReply:
    type: object
    properties:
      settings:
        $ref: '#/definitions/UserSettings'
  OrganizationInvitation:
    type: object
    properties:
      id:
        type: string
      email:
        type: string
      role:
        $ref: '#/definitions/UserRole.Role'
      status:
        $ref: '#/definitions/OrganizationInvitation.Status'
      expires_at:
        type: string
        format: date-time
      organization_id:
        type: string
      organization:
        $ref: '#/definitions/PublicOrganization'
      invitee_id:
        type: string
      invitee:
        $ref: '#/definitions/PublicUser'
      inviter_id:
        type: string
      inviter:
        $ref: '#/definitions/PublicUser'
  Organization.Status:
    type: string
    enum:
    - WARNING
    - LOCKED
    - ACTIVE
    - DEACTIVATING
    - DEACTIVATED
    - DELETING
    - DELETED
    default: WARNING
  User:
    type: object
    example:
      id: 78352123-a06f-4ec2-81ed-27a056725385
      email: john@snow.com
      name: John Snow
      avatar_url: https://www.gravatar.com/avatar/00000000000000000000000000000000
      is_admin: false
      is_test: true
      two_factor_authentication: false
      last_login: '0001-01-01T00:00:00Z'
      last_login_id: 10.1.1.1
      updated_at: '0001-01-01T00:00:00Z'
      created_at: '0001-01-01T00:00:00Z'
      newsletter_subscribed: true
      email_validated: true
    properties:
      id:
        type: string
      email:
        type: string
      avatar_url:
        type: string
      two_factor_authentication:
        type: boolean
      last_login:
        type: string
        format: date-time
      last_login_ip:
        type: string
      updated_at:
        type: string
        format: date-time
      created_at:
        type: string
        format: date-time
      newsletter_subscribed:
        type: boolean
      github_id:
        type: string
      github_user:
        type: string
      flags:
        type: array
        items:
          $ref: '#/definitions/UserFlags'
      name:
        type: string
      email_validated:
        type: boolean
      trialed:
        type: boolean
    title: Represent a User
  OrganizationInvitation.Status:
    type: string
    enum:
    - INVALID
    - PENDING
    - ACCEPTED
    - REFUSED
    - EXPIRED
    default: INVALID
  ClearIdenfyVerificationResultRequest:
    type: object
    properties:
      user_id:
        type: string
      organization_id:
        type: string
  GetIdenfyTokenReply:
    type: object
    properties:
      auth_token:
        type: string
  LoginReply:
    type: object
    properties:
      token:
        $ref: '#/definitions/Token'
  GetOrganizationReply:
    type: object
    properties:
      organization:
        $ref: '#/definitions/Organization'
  GetUserOrganizationInvitationReply:
    type: object
    properties:
      invitation:
        $ref: '#/definitions/OrganizationInvitation'
  ResendEmailValidationReply:
    type: object
  Organization.DeactivationReason:
    type: string
    enum:
    - INVALID
    - REQUESTED_BY_OWNER
    - SUBSCRIPTION_TERMINATION
    - LOCKED_BY_ADMIN
    - VERIFICATION_FAILED
    - TRIAL_DID_NOT_CONVERT
    default: INVALID
  ResetPasswordReply:
    type: object
  ListUserOrganizationInvitationsReply:
    type: object
    properties:
      invitations:
        type: array
        items:
          $ref: '#/definitions/OrganizationInvitation'
        title: The collection of organization invitations
      limit:
        type: integer
        format: int64
        title: The limit in the request
      offset:
        type: integer
        format: int64
        title: The offset in the request
      count:
        type: integer
        format: int64
        title: The total number of items
  google.protobuf.Any:
    type: object
    properties:
      '@type':
        type: string
    additionalProperties: {}
securityDefinitions:
  Bearer:
    type: apiKey
    name: Authorization
    in: header
x-tagGroups:
- name: Introduction
  tags:
  - intro
- name: API
  tags:
  - Profile
  - Sessions
  - Users
  - organization
  - OrganizationMembers
  - OrganizationInvitations
  - OrganizationConfirmations
  - Subscriptions
  - Coupons
  - Credentials
  - Secrets
  - activity
  - Apps
  - Services
  - Deployments
  - Archives
  - RegionalDeployments
  - Instances
  - Domains
  - PersistentVolumes
  - Snapshots
  - Compose
  - Repositories
  - Logs
  - Metrics
  - Catalog
  - CatalogRegions
  - CatalogInstances
  - Usages
  - Summary
  - DockerHelper