Koyeb Users API

swagger: '2.0'
info:
  title: Koyeb Rest activity Users 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: Users
paths:
  /v1/users/{id}:
    delete:
      summary: Delete user
      operationId: DeleteUser
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/DeleteUserReply'
        '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 user
        in: path
        required: true
        type: string
      tags:
      - Users
  /v2/users/{id}:
    delete:
      summary: V2 Delete user
      operationId: DeleteUserV2
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/DeleteUserReply'
        '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 user
        in: path
        required: true
        type: string
      tags:
      - Users
definitions:
  google.rpc.Status:
    type: object
    properties:
      code:
        type: integer
        format: int32
      message:
        type: string
      details:
        type: array
        items:
          $ref: '#/definitions/google.protobuf.Any'
  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"
  ErrorWithFields:
    type: object
    properties:
      status:
        type: integer
        format: int32
      code:
        type: string
      message:
        type: string
      fields:
        type: array
        items:
          $ref: '#/definitions/ErrorField'
  DeleteUserReply:
    type: object
    properties:
      user:
        $ref: '#/definitions/User'
  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
  google.protobuf.Any:
    type: object
    properties:
      '@type':
        type: string
    additionalProperties: {}
  ErrorField:
    type: object
    properties:
      field:
        type: string
      description:
        type: string
  Error:
    type: object
    properties:
      status:
        type: integer
        format: int32
      code:
        type: string
      message:
        type: string
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