swagger: '2.0' info: title: The Things Stack — Application Server AppAs OrganizationRegistry API version: v3.36 description: The Things Stack is an open-source LoRaWAN Network Server implementation. This OpenAPI was derived from the upstream gRPC-Gateway generated api.swagger.json published by TheThingsNetwork/lorawan-stack v3.36. license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0 contact: name: The Things Industries url: https://www.thethingsindustries.com host: eu1.cloud.thethings.industries basePath: /api/v3 schemes: - https consumes: - application/json produces: - application/json security: - ApiKeyAuth: [] tags: - name: OrganizationRegistry paths: /organizations: get: summary: 'List organizations where the given user or organization is a direct collaborator. If no user or organization is given, this returns the organizations the caller has access to. Similar to Get, this selects the fields given by the field mask. More or less fields may be returned, depending on the rights of the caller.' operationId: OrganizationRegistry_List responses: '200': description: A successful response. schema: $ref: '#/definitions/v3Organizations' default: description: An unexpected error response. schema: $ref: '#/definitions/googlerpcStatus' parameters: - name: collaborator.organization_ids.organization_id description: This ID shares namespace with user IDs. in: query required: false type: string - name: collaborator.user_ids.user_id description: This ID shares namespace with organization IDs. in: query required: false type: string - name: collaborator.user_ids.email description: Secondary identifier, which can only be used in specific requests. in: query required: false type: string - name: field_mask description: The names of the organization fields that should be returned. in: query required: false type: string - name: order description: 'Order the results by this field path (must be present in the field mask). Default ordering is by ID. Prepend with a minus (-) to reverse the order.' in: query required: false type: string - name: limit description: Limit the number of results per page. in: query required: false type: integer format: int64 - name: page description: Page number for pagination. 0 is interpreted as 1. in: query required: false type: integer format: int64 - name: deleted description: Only return recently deleted organizations. in: query required: false type: boolean tags: - OrganizationRegistry /organizations/{organization.ids.organization_id}: put: summary: Update the organization, changing the fields specified by the field mask to the provided values. operationId: OrganizationRegistry_Update responses: '200': description: A successful response. schema: $ref: '#/definitions/v3Organization' default: description: An unexpected error response. schema: $ref: '#/definitions/googlerpcStatus' parameters: - name: organization.ids.organization_id description: This ID shares namespace with user IDs. in: path required: true type: string - name: body in: body required: true schema: $ref: '#/definitions/v3OrganizationRegistryUpdateBody' tags: - OrganizationRegistry /organizations/{organization_ids.organization_id}: get: summary: 'Get the organization with the given identifiers, selecting the fields specified in the field mask. More or less fields may be returned, depending on the rights of the caller.' operationId: OrganizationRegistry_Get responses: '200': description: A successful response. schema: $ref: '#/definitions/v3Organization' default: description: An unexpected error response. schema: $ref: '#/definitions/googlerpcStatus' parameters: - name: organization_ids.organization_id description: This ID shares namespace with user IDs. in: path required: true type: string - name: field_mask description: The names of the organization fields that should be returned. in: query required: false type: string tags: - OrganizationRegistry /organizations/{organization_id}: delete: summary: Delete the organization. This may not release the organization ID for reuse. operationId: OrganizationRegistry_Delete responses: '200': description: A successful response. schema: type: object properties: {} default: description: An unexpected error response. schema: $ref: '#/definitions/googlerpcStatus' parameters: - name: organization_id description: This ID shares namespace with user IDs. in: path required: true type: string tags: - OrganizationRegistry /organizations/{organization_id}/purge: delete: summary: 'Purge the organization. This will release the organization ID for reuse. The user is responsible for clearing data from any (external) integrations that may store and expose data by user or organization ID.' operationId: OrganizationRegistry_Purge responses: '200': description: A successful response. schema: type: object properties: {} default: description: An unexpected error response. schema: $ref: '#/definitions/googlerpcStatus' parameters: - name: organization_id description: This ID shares namespace with user IDs. in: path required: true type: string tags: - OrganizationRegistry /organizations/{organization_id}/restore: post: summary: Restore a recently deleted organization. description: 'Deployment configuration may specify if, and for how long after deletion, entities can be restored.' operationId: OrganizationRegistry_Restore responses: '200': description: A successful response. schema: type: object properties: {} default: description: An unexpected error response. schema: $ref: '#/definitions/googlerpcStatus' parameters: - name: organization_id description: This ID shares namespace with user IDs. in: path required: true type: string tags: - OrganizationRegistry /users/{collaborator.user_ids.user_id}/organizations: get: summary: 'List organizations where the given user or organization is a direct collaborator. If no user or organization is given, this returns the organizations the caller has access to. Similar to Get, this selects the fields given by the field mask. More or less fields may be returned, depending on the rights of the caller.' operationId: OrganizationRegistry_List2 responses: '200': description: A successful response. schema: $ref: '#/definitions/v3Organizations' default: description: An unexpected error response. schema: $ref: '#/definitions/googlerpcStatus' parameters: - name: collaborator.user_ids.user_id description: This ID shares namespace with organization IDs. in: path required: true type: string - name: collaborator.organization_ids.organization_id description: This ID shares namespace with user IDs. in: query required: false type: string - name: collaborator.user_ids.email description: Secondary identifier, which can only be used in specific requests. in: query required: false type: string - name: field_mask description: The names of the organization fields that should be returned. in: query required: false type: string - name: order description: 'Order the results by this field path (must be present in the field mask). Default ordering is by ID. Prepend with a minus (-) to reverse the order.' in: query required: false type: string - name: limit description: Limit the number of results per page. in: query required: false type: integer format: int64 - name: page description: Page number for pagination. 0 is interpreted as 1. in: query required: false type: integer format: int64 - name: deleted description: Only return recently deleted organizations. in: query required: false type: boolean tags: - OrganizationRegistry post: summary: 'Create a new organization. This also sets the given user as first collaborator with all possible rights.' operationId: OrganizationRegistry_Create responses: '200': description: A successful response. schema: $ref: '#/definitions/v3Organization' default: description: An unexpected error response. schema: $ref: '#/definitions/googlerpcStatus' parameters: - name: collaborator.user_ids.user_id description: This ID shares namespace with organization IDs. in: path required: true type: string - name: body in: body required: true schema: $ref: '#/definitions/v3OrganizationRegistryCreateBody' tags: - OrganizationRegistry definitions: v3Organization: type: object properties: ids: $ref: '#/definitions/v3OrganizationIdentifiers' description: The identifiers of the organization. These are public and can be seen by any authenticated user in the network. created_at: type: string format: date-time description: When the organization was created. This information is public and can be seen by any authenticated user in the network. updated_at: type: string format: date-time description: When the organization was last updated. This information is public and can be seen by any authenticated user in the network. deleted_at: type: string format: date-time description: When the organization was deleted. This information is public and can be seen by any authenticated user in the network. name: type: string description: The name of the organization. This information is public and can be seen by any authenticated user in the network. description: type: string description: A description for the organization. attributes: type: object additionalProperties: type: string description: Key-value attributes for this organization. Typically used for organizing organizations or for storing integration-specific data. contact_info: type: array items: type: object $ref: '#/definitions/v3ContactInfo' description: 'Contact information for this organization. Typically used to indicate who to contact with security/billing questions about the organization. This field is deprecated. Use administrative_contact and technical_contact instead.' administrative_contact: $ref: '#/definitions/v3OrganizationOrUserIdentifiers' technical_contact: $ref: '#/definitions/v3OrganizationOrUserIdentifiers' fanout_notifications: type: boolean description: 'Determines if a notification will be sent to the collaborators. If false it, notifications will be sent only to the administrative or technical contact.' googlerpcStatus: type: object properties: code: type: integer format: int32 message: type: string details: type: array items: type: object $ref: '#/definitions/protobufAny' v3ContactMethod: type: string enum: - CONTACT_METHOD_OTHER - CONTACT_METHOD_EMAIL - CONTACT_METHOD_PHONE default: CONTACT_METHOD_OTHER v3OrganizationOrUserIdentifiers: type: object properties: organization_ids: $ref: '#/definitions/v3OrganizationIdentifiers' user_ids: $ref: '#/definitions/v3UserIdentifiers' description: OrganizationOrUserIdentifiers contains either organization or user identifiers. v3ContactType: type: string enum: - CONTACT_TYPE_OTHER - CONTACT_TYPE_ABUSE - CONTACT_TYPE_BILLING - CONTACT_TYPE_TECHNICAL default: CONTACT_TYPE_OTHER v3Organizations: type: object properties: organizations: type: array items: type: object $ref: '#/definitions/v3Organization' v3OrganizationRegistryUpdateBody: type: object properties: organization: type: object properties: ids: type: object description: The identifiers of the organization. These are public and can be seen by any authenticated user in the network. title: The identifiers of the organization. These are public and can be seen by any authenticated user in the network. created_at: type: string format: date-time description: When the organization was created. This information is public and can be seen by any authenticated user in the network. updated_at: type: string format: date-time description: When the organization was last updated. This information is public and can be seen by any authenticated user in the network. deleted_at: type: string format: date-time description: When the organization was deleted. This information is public and can be seen by any authenticated user in the network. name: type: string description: The name of the organization. This information is public and can be seen by any authenticated user in the network. description: type: string description: A description for the organization. attributes: type: object additionalProperties: type: string description: Key-value attributes for this organization. Typically used for organizing organizations or for storing integration-specific data. contact_info: type: array items: type: object $ref: '#/definitions/v3ContactInfo' description: 'Contact information for this organization. Typically used to indicate who to contact with security/billing questions about the organization. This field is deprecated. Use administrative_contact and technical_contact instead.' administrative_contact: $ref: '#/definitions/v3OrganizationOrUserIdentifiers' technical_contact: $ref: '#/definitions/v3OrganizationOrUserIdentifiers' fanout_notifications: type: boolean description: 'Determines if a notification will be sent to the collaborators. If false it, notifications will be sent only to the administrative or technical contact.' field_mask: type: string description: The names of the organization fields that should be updated. v3UserIdentifiers: type: object properties: user_id: type: string description: This ID shares namespace with organization IDs. email: type: string description: Secondary identifier, which can only be used in specific requests. v3ContactInfo: type: object properties: contact_type: $ref: '#/definitions/v3ContactType' contact_method: $ref: '#/definitions/v3ContactMethod' value: type: string public: type: boolean validated_at: type: string format: date-time protobufAny: 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. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\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 // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\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\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 }" v3OrganizationRegistryCreateBody: type: object properties: organization: $ref: '#/definitions/v3Organization' collaborator: type: object properties: organization_ids: $ref: '#/definitions/v3OrganizationIdentifiers' user_ids: type: object properties: email: type: string description: Secondary identifier, which can only be used in specific requests. description: 'Collaborator to grant all rights on the newly created application. NOTE: It is currently not possible to have organizations collaborating on other organizations.' title: 'Collaborator to grant all rights on the newly created application. NOTE: It is currently not possible to have organizations collaborating on other organizations.' v3OrganizationIdentifiers: type: object properties: organization_id: type: string description: This ID shares namespace with user IDs. securityDefinitions: ApiKeyAuth: type: apiKey in: header name: Authorization description: 'Bearer API key. Set Authorization: Bearer NNSXS.xxxxxxxxxx.'