openapi: 3.2.0 info: title: Koyeb Rest Organization Invitations 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 servers: - url: https://app.koyeb.com security: - Bearer: [] tags: - name: Organization Invitations paths: /v1/organization_invitations: get: summary: List Organization Invitations operationId: ListOrganizationInvitations responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/ListOrganizationInvitationsReply' '400': description: Validation error content: application/json: schema: $ref: '#/components/schemas/ErrorWithFields' '401': description: Returned when the token is not valid. content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: Returned when the user does not have permission to access the resource. content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: Returned when the resource does not exist. content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: Returned in case of server error. content: application/json: schema: $ref: '#/components/schemas/Error' '503': description: Service is unavailable. content: application/json: schema: $ref: '#/components/schemas/Error' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/google.rpc.Status' parameters: - name: limit description: (Optional) The number of items to return in: query required: false schema: type: string - name: offset description: (Optional) The offset in the list of item to return in: query required: false schema: type: string - name: statuses description: (Optional) Filter on organization invitation statuses in: query required: false style: form explode: true schema: type: array items: type: string enum: - INVALID - PENDING - ACCEPTED - REFUSED - EXPIRED - name: user_id description: '(Optional) Filter on invitee ID. Will match both invitations sent to that user_id and invitations sent to the email of that user_id. The only valid value is the requester''s user_id' in: query required: false schema: type: string tags: - Organization Invitations post: summary: Create Organization Invitation operationId: CreateOrganizationInvitation responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/CreateOrganizationInvitationReply' '400': description: Validation error content: application/json: schema: $ref: '#/components/schemas/ErrorWithFields' '401': description: Returned when the token is not valid. content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: Returned when the user does not have permission to access the resource. content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: Returned when the resource does not exist. content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: Returned in case of server error. content: application/json: schema: $ref: '#/components/schemas/Error' '503': description: Service is unavailable. content: application/json: schema: $ref: '#/components/schemas/Error' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/google.rpc.Status' tags: - Organization Invitations requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateOrganizationInvitationRequest' required: true /v1/organization_invitations/{id}: get: summary: Get Organization Invitation operationId: GetOrganizationInvitation responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/GetOrganizationInvitationReply' '400': description: Validation error content: application/json: schema: $ref: '#/components/schemas/ErrorWithFields' '401': description: Returned when the token is not valid. content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: Returned when the user does not have permission to access the resource. content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: Returned when the resource does not exist. content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: Returned in case of server error. content: application/json: schema: $ref: '#/components/schemas/Error' '503': description: Service is unavailable. content: application/json: schema: $ref: '#/components/schemas/Error' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/google.rpc.Status' parameters: - name: id description: The id of the invitation to get in: path required: true schema: type: string tags: - Organization Invitations delete: summary: Delete Organization Invitation operationId: DeleteOrganizationInvitation responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/DeleteOrganizationInvitationReply' '400': description: Validation error content: application/json: schema: $ref: '#/components/schemas/ErrorWithFields' '401': description: Returned when the token is not valid. content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: Returned when the user does not have permission to access the resource. content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: Returned when the resource does not exist. content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: Returned in case of server error. content: application/json: schema: $ref: '#/components/schemas/Error' '503': description: Service is unavailable. content: application/json: schema: $ref: '#/components/schemas/Error' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/google.rpc.Status' parameters: - name: id description: The id of the organization invitation to delete in: path required: true schema: type: string tags: - Organization Invitations /v1/organization_invitations/{id}/resend: post: summary: Resend Organization Invitation operationId: ResendOrganizationInvitation responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/ResendOrganizationInvitationReply' '400': description: Validation error content: application/json: schema: $ref: '#/components/schemas/ErrorWithFields' '401': description: Returned when the token is not valid. content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: Returned when the user does not have permission to access the resource. content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: Returned when the resource does not exist. content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: Returned in case of server error. content: application/json: schema: $ref: '#/components/schemas/Error' '503': description: Service is unavailable. content: application/json: schema: $ref: '#/components/schemas/Error' default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/google.rpc.Status' parameters: - name: id description: The id of the organization invitation to resend in: path required: true schema: type: string tags: - Organization Invitations requestBody: content: application/json: schema: type: object required: true components: schemas: ErrorField: type: object properties: field: type: string description: type: string OrganizationInvitation.Status: type: string enum: - INVALID - PENDING - ACCEPTED - REFUSED - EXPIRED default: INVALID ResendOrganizationInvitationReply: type: object properties: invitation: $ref: '#/components/schemas/OrganizationInvitation' title: The organization invitation resent UserRole.Role: type: string enum: - INVALID - OWNER default: INVALID google.protobuf.Any: type: object properties: '@type': type: string description: "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics." additionalProperties: {} description: "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(&foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := &pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := &pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": ,\n \"lastName\": \n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }" CreateOrganizationInvitationRequest: type: object properties: email: type: string title: The email of the person to invite OrganizationInvitation: type: object properties: id: type: string email: type: string role: $ref: '#/components/schemas/UserRole.Role' status: $ref: '#/components/schemas/OrganizationInvitation.Status' expires_at: type: string format: date-time organization_id: type: string organization: $ref: '#/components/schemas/PublicOrganization' invitee_id: type: string invitee: $ref: '#/components/schemas/PublicUser' inviter_id: type: string inviter: $ref: '#/components/schemas/PublicUser' PublicOrganization: type: object properties: id: type: string name: type: string plan: $ref: '#/components/schemas/Plan' status: $ref: '#/components/schemas/Organization.Status' external_id: type: string 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 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 google.rpc.Status: type: object properties: code: type: integer format: int32 message: type: string details: type: array items: $ref: '#/components/schemas/google.protobuf.Any' DeleteOrganizationInvitationReply: type: object Organization.Status: type: string enum: - WARNING - LOCKED - ACTIVE - DEACTIVATING - DEACTIVATED - DELETING - DELETED default: WARNING ListOrganizationInvitationsReply: type: object properties: invitations: type: array items: $ref: '#/components/schemas/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 GetOrganizationInvitationReply: type: object properties: invitation: $ref: '#/components/schemas/OrganizationInvitation' ErrorWithFields: type: object properties: status: type: integer format: int32 code: type: string message: type: string fields: type: array items: $ref: '#/components/schemas/ErrorField' CreateOrganizationInvitationReply: type: object properties: invitation: $ref: '#/components/schemas/OrganizationInvitation' title: The organization invitation sent securitySchemes: Bearer: type: apiKey name: Authorization in: header x-tagGroups: - name: Introduction tags: - intro - name: API tags: - Profile - Sessions - Users - organization - Projects - 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