openapi: 3.2.0 info: title: Koyeb Rest Organization Members 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 Members paths: /v1/organization_members: get: summary: List organization members operationId: ListOrganizationMembers responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/ListOrganizationMembersReply' '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: organization_id description: (Optional) Filter for an organization in: query required: false schema: type: string - name: user_id description: (Optional) Filter for an user in: query required: false schema: type: string - name: organization_statuses description: (Optional) Filter for organization statuses in: query required: false style: form explode: true schema: type: array items: type: string enum: - WARNING - LOCKED - ACTIVE - DEACTIVATING - DEACTIVATED - DELETING - DELETED tags: - Organization Members /v1/organization_members/{id}: delete: summary: Remove an organization member operationId: RemoveOrganizationMember responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/RemoveOrganizationMemberReply' '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 in: path required: true schema: type: string tags: - Organization Members components: schemas: ListOrganizationMembersReply: type: object properties: members: type: array items: $ref: '#/components/schemas/OrganizationMember' title: The collection of organization members 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 OrganizationMember: type: object properties: id: type: string organization_id: type: string user_id: type: string external_id: type: string joined_at: type: string format: date-time role: $ref: '#/components/schemas/UserRole.Role' status: $ref: '#/components/schemas/OrganizationMember.Status' user: $ref: '#/components/schemas/PublicUser' organization: $ref: '#/components/schemas/PublicOrganization' OrganizationMember.Status: type: string enum: - INVALID - ACTIVE - DELETED default: INVALID 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 }" RemoveOrganizationMemberReply: type: object properties: member: $ref: '#/components/schemas/OrganizationMember' 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 google.rpc.Status: type: object properties: code: type: integer format: int32 message: type: string details: type: array items: $ref: '#/components/schemas/google.protobuf.Any' Error: type: object properties: status: type: integer format: int32 code: type: string message: type: string Plan: type: string enum: - hobby - starter - startup - business - enterprise - internal - hobby23 - no_plan - pro - scale - partner_csp - partner_csp_unit default: hobby 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 Organization.Status: type: string enum: - WARNING - LOCKED - ACTIVE - DEACTIVATING - DEACTIVATED - DELETING - DELETED default: WARNING ErrorWithFields: type: object properties: status: type: integer format: int32 code: type: string message: type: string fields: type: array items: $ref: '#/components/schemas/ErrorField' ErrorField: type: object properties: field: type: string description: type: string 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