The Things Network / The Things Stack EntityRegistrySearch API

openapi: 3.2.0
info:
  title: Things Stack — Application Server AppAs Entity Registry Search 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
servers:
- url: https://eu1.cloud.thethings.industries/api/v3
security:
- ApiKeyAuth: []
tags:
- name: EntityRegistrySearch
paths:
  /applications/{application_ids.application_id}/collaborators/search:
    get:
      summary: Search for accounts that match the conditions specified in the request.
      operationId: EntityRegistrySearch_SearchAccounts2
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v3SearchAccountsResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/googlerpcStatus'
      parameters:
      - name: application_ids.application_id
        in: path
        required: true
        schema:
          type: string
      - name: query
        in: query
        required: false
        schema:
          type: string
      - name: only_users
        in: query
        required: false
        schema:
          type: boolean
      - name: client_ids.client_id
        in: query
        required: false
        schema:
          type: string
      - name: gateway_ids.gateway_id
        in: query
        required: false
        schema:
          type: string
      - name: gateway_ids.eui
        description: Secondary identifier, which can only be used in specific requests.
        in: query
        required: false
        schema:
          type: string
          format: string
      - name: organization_ids.organization_id
        description: This ID shares namespace with user IDs.
        in: query
        required: false
        schema:
          type: string
      - name: complement_collaborators
        in: query
        required: false
        schema:
          type: boolean
      tags:
      - EntityRegistrySearch
  /clients/{client_ids.client_id}/collaborators/search:
    get:
      summary: Search for accounts that match the conditions specified in the request.
      operationId: EntityRegistrySearch_SearchAccounts3
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v3SearchAccountsResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/googlerpcStatus'
      parameters:
      - name: client_ids.client_id
        in: path
        required: true
        schema:
          type: string
      - name: query
        in: query
        required: false
        schema:
          type: string
      - name: only_users
        in: query
        required: false
        schema:
          type: boolean
      - name: application_ids.application_id
        in: query
        required: false
        schema:
          type: string
      - name: gateway_ids.gateway_id
        in: query
        required: false
        schema:
          type: string
      - name: gateway_ids.eui
        description: Secondary identifier, which can only be used in specific requests.
        in: query
        required: false
        schema:
          type: string
          format: string
      - name: organization_ids.organization_id
        description: This ID shares namespace with user IDs.
        in: query
        required: false
        schema:
          type: string
      - name: complement_collaborators
        in: query
        required: false
        schema:
          type: boolean
      tags:
      - EntityRegistrySearch
  /gateways/{gateway_ids.gateway_id}/collaborators/search:
    get:
      summary: Search for accounts that match the conditions specified in the request.
      operationId: EntityRegistrySearch_SearchAccounts4
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v3SearchAccountsResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/googlerpcStatus'
      parameters:
      - name: gateway_ids.gateway_id
        in: path
        required: true
        schema:
          type: string
      - name: query
        in: query
        required: false
        schema:
          type: string
      - name: only_users
        in: query
        required: false
        schema:
          type: boolean
      - name: application_ids.application_id
        in: query
        required: false
        schema:
          type: string
      - name: client_ids.client_id
        in: query
        required: false
        schema:
          type: string
      - name: gateway_ids.eui
        description: Secondary identifier, which can only be used in specific requests.
        in: query
        required: false
        schema:
          type: string
          format: string
      - name: organization_ids.organization_id
        description: This ID shares namespace with user IDs.
        in: query
        required: false
        schema:
          type: string
      - name: complement_collaborators
        in: query
        required: false
        schema:
          type: boolean
      tags:
      - EntityRegistrySearch
  /organizations/{organization_ids.organization_id}/collaborators/search:
    get:
      summary: Search for accounts that match the conditions specified in the request.
      operationId: EntityRegistrySearch_SearchAccounts5
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v3SearchAccountsResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/googlerpcStatus'
      parameters:
      - name: organization_ids.organization_id
        description: This ID shares namespace with user IDs.
        in: path
        required: true
        schema:
          type: string
      - name: query
        in: query
        required: false
        schema:
          type: string
      - name: only_users
        in: query
        required: false
        schema:
          type: boolean
      - name: application_ids.application_id
        in: query
        required: false
        schema:
          type: string
      - name: client_ids.client_id
        in: query
        required: false
        schema:
          type: string
      - name: gateway_ids.gateway_id
        in: query
        required: false
        schema:
          type: string
      - name: gateway_ids.eui
        description: Secondary identifier, which can only be used in specific requests.
        in: query
        required: false
        schema:
          type: string
          format: string
      - name: complement_collaborators
        in: query
        required: false
        schema:
          type: boolean
      tags:
      - EntityRegistrySearch
  /search/accounts:
    get:
      summary: Search for accounts that match the conditions specified in the request.
      operationId: EntityRegistrySearch_SearchAccounts
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v3SearchAccountsResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/googlerpcStatus'
      parameters:
      - name: query
        in: query
        required: false
        schema:
          type: string
      - name: only_users
        in: query
        required: false
        schema:
          type: boolean
      - name: application_ids.application_id
        in: query
        required: false
        schema:
          type: string
      - name: client_ids.client_id
        in: query
        required: false
        schema:
          type: string
      - name: gateway_ids.gateway_id
        in: query
        required: false
        schema:
          type: string
      - name: gateway_ids.eui
        description: Secondary identifier, which can only be used in specific requests.
        in: query
        required: false
        schema:
          type: string
          format: string
      - name: organization_ids.organization_id
        description: This ID shares namespace with user IDs.
        in: query
        required: false
        schema:
          type: string
      - name: complement_collaborators
        in: query
        required: false
        schema:
          type: boolean
      tags:
      - EntityRegistrySearch
  /search/applications:
    get:
      summary: 'Search for applications that match the conditions specified in the request.

        Non-admin users will only match applications that they have rights on.'
      operationId: EntityRegistrySearch_SearchApplications
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v3Applications'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/googlerpcStatus'
      parameters:
      - name: query
        description: Find applications where the ID, name or description contains this substring.
        in: query
        required: false
        schema:
          type: string
      - name: id_contains
        description: Find applications where the ID contains this substring.
        in: query
        required: false
        schema:
          type: string
      - name: name_contains
        description: Find applications where the name contains this substring.
        in: query
        required: false
        schema:
          type: string
      - name: description_contains
        description: Find applications where the description contains this substring.
        in: query
        required: false
        schema:
          type: string
      - name: attributes_contain[string]
        description: This is a request variable of the map type. The query format is "map_name[key]=value", e.g. If the map name is Age, the key type is string, and the value type is integer, the query parameter is expressed as Age["bob"]=18
        in: query
        required: false
        schema:
          type: string
      - name: field_mask
        in: query
        required: false
        schema:
          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
        schema:
          type: string
      - name: limit
        description: Limit the number of results per page.
        in: query
        required: false
        schema:
          type: integer
          format: int64
      - name: page
        description: Page number for pagination. 0 is interpreted as 1.
        in: query
        required: false
        schema:
          type: integer
          format: int64
      - name: deleted
        description: Only return recently deleted applications.
        in: query
        required: false
        schema:
          type: boolean
      tags:
      - EntityRegistrySearch
  /search/clients:
    get:
      summary: 'Search for OAuth clients that match the conditions specified in the request.

        Non-admin users will only match OAuth clients that they have rights on.'
      operationId: EntityRegistrySearch_SearchClients
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v3Clients'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/googlerpcStatus'
      parameters:
      - name: query
        description: Find OAuth clients where the ID, name or description contains this substring.
        in: query
        required: false
        schema:
          type: string
      - name: id_contains
        description: Find OAuth clients where the ID contains this substring.
        in: query
        required: false
        schema:
          type: string
      - name: name_contains
        description: Find OAuth clients where the name contains this substring.
        in: query
        required: false
        schema:
          type: string
      - name: description_contains
        description: Find OAuth clients where the description contains this substring.
        in: query
        required: false
        schema:
          type: string
      - name: attributes_contain[string]
        description: This is a request variable of the map type. The query format is "map_name[key]=value", e.g. If the map name is Age, the key type is string, and the value type is integer, the query parameter is expressed as Age["bob"]=18
        in: query
        required: false
        schema:
          type: string
      - name: state
        description: "Find OAuth clients where the state is any of these states.\n\n - STATE_REQUESTED: Denotes that the entity has been requested and is pending review by an admin.\n - STATE_APPROVED: Denotes that the entity has been reviewed and approved by an admin.\n - STATE_REJECTED: Denotes that the entity has been reviewed and rejected by an admin.\n - STATE_FLAGGED: Denotes that the entity has been flagged and is pending review by an admin.\n - STATE_SUSPENDED: Denotes that the entity has been reviewed and suspended by an admin."
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - STATE_REQUESTED
            - STATE_APPROVED
            - STATE_REJECTED
            - STATE_FLAGGED
            - STATE_SUSPENDED
      - name: field_mask
        in: query
        required: false
        schema:
          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
        schema:
          type: string
      - name: limit
        description: Limit the number of results per page.
        in: query
        required: false
        schema:
          type: integer
          format: int64
      - name: page
        description: Page number for pagination. 0 is interpreted as 1.
        in: query
        required: false
        schema:
          type: integer
          format: int64
      - name: deleted
        description: Only return recently deleted OAuth clients.
        in: query
        required: false
        schema:
          type: boolean
      tags:
      - EntityRegistrySearch
  /search/gateways:
    get:
      summary: 'Search for gateways that match the conditions specified in the request.

        Non-admin users will only match gateways that they have rights on.'
      operationId: EntityRegistrySearch_SearchGateways
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v3Gateways'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/googlerpcStatus'
      parameters:
      - name: query
        description: Find gateways where the ID, name, description or EUI contains this substring.
        in: query
        required: false
        schema:
          type: string
      - name: id_contains
        description: Find gateways where the ID contains this substring.
        in: query
        required: false
        schema:
          type: string
      - name: name_contains
        description: Find gateways where the name contains this substring.
        in: query
        required: false
        schema:
          type: string
      - name: description_contains
        description: Find gateways where the description contains this substring.
        in: query
        required: false
        schema:
          type: string
      - name: attributes_contain[string]
        description: This is a request variable of the map type. The query format is "map_name[key]=value", e.g. If the map name is Age, the key type is string, and the value type is integer, the query parameter is expressed as Age["bob"]=18
        in: query
        required: false
        schema:
          type: string
      - name: eui_contains
        description: Find gateways where the (hexadecimal) EUI contains this substring.
        in: query
        required: false
        schema:
          type: string
      - name: field_mask
        in: query
        required: false
        schema:
          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
        schema:
          type: string
      - name: limit
        description: Limit the number of results per page.
        in: query
        required: false
        schema:
          type: integer
          format: int64
      - name: page
        description: Page number for pagination. 0 is interpreted as 1.
        in: query
        required: false
        schema:
          type: integer
          format: int64
      - name: deleted
        description: Only return recently deleted gateways.
        in: query
        required: false
        schema:
          type: boolean
      tags:
      - EntityRegistrySearch
  /search/organizations:
    get:
      summary: 'Search for organizations that match the conditions specified in the request.

        Non-admin users will only match organizations that they have rights on.'
      operationId: EntityRegistrySearch_SearchOrganizations
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v3Organizations'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/googlerpcStatus'
      parameters:
      - name: query
        description: Find organizations where the ID, name or description contains this substring.
        in: query
        required: false
        schema:
          type: string
      - name: id_contains
        description: Find organizations where the ID contains this substring.
        in: query
        required: false
        schema:
          type: string
      - name: name_contains
        description: Find organizations where the name contains this substring.
        in: query
        required: false
        schema:
          type: string
      - name: description_contains
        description: Find organizations where the description contains this substring.
        in: query
        required: false
        schema:
          type: string
      - name: attributes_contain[string]
        description: This is a request variable of the map type. The query format is "map_name[key]=value", e.g. If the map name is Age, the key type is string, and the value type is integer, the query parameter is expressed as Age["bob"]=18
        in: query
        required: false
        schema:
          type: string
      - name: field_mask
        in: query
        required: false
        schema:
          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
        schema:
          type: string
      - name: limit
        description: Limit the number of results per page.
        in: query
        required: false
        schema:
          type: integer
          format: int64
      - name: page
        description: Page number for pagination. 0 is interpreted as 1.
        in: query
        required: false
        schema:
          type: integer
          format: int64
      - name: deleted
        description: Only return recently deleted organizations.
        in: query
        required: false
        schema:
          type: boolean
      tags:
      - EntityRegistrySearch
  /search/users:
    get:
      summary: 'Search for users that match the conditions specified in the request.

        This is only available to admin users.'
      operationId: EntityRegistrySearch_SearchUsers
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v3Users'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/googlerpcStatus'
      parameters:
      - name: query
        description: Find users where the ID, name or description contains this substring.
        in: query
        required: false
        schema:
          type: string
      - name: id_contains
        description: Find users where the ID contains this substring.
        in: query
        required: false
        schema:
          type: string
      - name: name_contains
        description: Find users where the name contains this substring.
        in: query
        required: false
        schema:
          type: string
      - name: description_contains
        description: Find users where the description contains this substring.
        in: query
        required: false
        schema:
          type: string
      - name: attributes_contain[string]
        description: This is a request variable of the map type. The query format is "map_name[key]=value", e.g. If the map name is Age, the key type is string, and the value type is integer, the query parameter is expressed as Age["bob"]=18
        in: query
        required: false
        schema:
          type: string
      - name: state
        description: "Find users where the state is any of these states.\n\n - STATE_REQUESTED: Denotes that the entity has been requested and is pending review by an admin.\n - STATE_APPROVED: Denotes that the entity has been reviewed and approved by an admin.\n - STATE_REJECTED: Denotes that the entity has been reviewed and rejected by an admin.\n - STATE_FLAGGED: Denotes that the entity has been flagged and is pending review by an admin.\n - STATE_SUSPENDED: Denotes that the entity has been reviewed and suspended by an admin."
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - STATE_REQUESTED
            - STATE_APPROVED
            - STATE_REJECTED
            - STATE_FLAGGED
            - STATE_SUSPENDED
      - name: field_mask
        in: query
        required: false
        schema:
          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
        schema:
          type: string
      - name: limit
        description: Limit the number of results per page.
        in: query
        required: false
        schema:
          type: integer
          format: int64
      - name: page
        description: Page number for pagination. 0 is interpreted as 1.
        in: query
        required: false
        schema:
          type: integer
          format: int64
      - name: deleted
        description: Only return recently deleted users.
        in: query
        required: false
        schema:
          type: boolean
      tags:
      - EntityRegistrySearch
components:
  schemas:
    v3LocationSource:
      type: string
      enum:
      - SOURCE_UNKNOWN
      - SOURCE_GPS
      - SOURCE_REGISTRY
      - SOURCE_IP_GEOLOCATION
      - SOURCE_WIFI_RSSI_GEOLOCATION
      - SOURCE_BT_RSSI_GEOLOCATION
      - SOURCE_LORA_RSSI_GEOLOCATION
      - SOURCE_LORA_TDOA_GEOLOCATION
      - SOURCE_COMBINED_GEOLOCATION
      default: SOURCE_UNKNOWN
      description: " - SOURCE_UNKNOWN: The source of the location is not known or not set.\n - SOURCE_GPS: The location is determined by GPS.\n - SOURCE_REGISTRY: The location is set in and updated from a registry.\n - SOURCE_IP_GEOLOCATION: The location is estimated with IP geolocation.\n - SOURCE_WIFI_RSSI_GEOLOCATION: The location is estimated with WiFi RSSI geolocation.\n - SOURCE_BT_RSSI_GEOLOCATION: The location is estimated with BT/BLE RSSI geolocation.\n - SOURCE_LORA_RSSI_GEOLOCATION: The location is estimated with LoRa RSSI geolocation.\n - SOURCE_LORA_TDOA_GEOLOCATION: The location is estimated with LoRa TDOA geolocation.\n - SOURCE_COMBINED_GEOLOCATION: The location is estimated by a combination of geolocation sources.\n\nMore estimation methods can be added."
    UserConsolePreferencesDashboardLayouts:
      type: object
      properties:
        api_key:
          $ref: '#/components/schemas/v3DashboardLayout'
        application:
          $ref: '#/components/schemas/v3DashboardLayout'
        collaborator:
          $ref: '#/components/schemas/v3DashboardLayout'
        end_device:
          $ref: '#/components/schemas/v3DashboardLayout'
        gateway:
          $ref: '#/components/schemas/v3DashboardLayout'
        organization:
          $ref: '#/components/schemas/v3DashboardLayout'
        overview:
          $ref: '#/components/schemas/v3DashboardLayout'
        user:
          $ref: '#/components/schemas/v3DashboardLayout'
    v3GatewayAntenna:
      type: object
      properties:
        gain:
          type: number
          format: float
          description: Antenna gain relative to the gateway, in dBi.
        location:
          $ref: '#/components/schemas/lorawanv3Location'
          description: location is the antenna's location.
        attributes:
          type: object
          additionalProperties:
            type: string
        placement:
          $ref: '#/components/schemas/v3GatewayAntennaPlacement'
      description: GatewayAntenna is the message that defines a gateway antenna.
    PictureEmbedded:
      type: object
      properties:
        mime_type:
          type: string
          description: MIME type of the picture.
        data:
          type: string
          format: byte
          description: 'Picture data. A data URI can be constructed as follows:

            `data:<mime_type>;base64,<data>`.'
    UserConsolePreferencesSortBy:
      type: object
      properties:
        api_key:
          type: string
        application:
          type: string
        collaborator:
          type: string
        end_device:
          type: string
        gateway:
          type: string
        organization:
          type: string
        user:
          type: string
      description: SortBy defines the field to which the Console will sort the display of entities.
    v3Client:
      type: object
      properties:
        ids:
          $ref: '#/components/schemas/v3ClientIdentifiers'
          description: The identifiers of the OAuth client. These are public and can be seen by any authenticated user in the network.
        created_at:
          type: string
          format: date-time
          description: When the OAuth client 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 OAuth client 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 OAuth client 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 OAuth client. This information is public and can be seen by any authenticated user in the network.
        description:
          type: string
          description: A description for the OAuth client. This information is public and can be seen by any authenticated user in the network.
        attributes:
          type: object
          additionalProperties:
            type: string
          description: Key-value attributes for this client. Typically used for organizing clients or for storing integration-specific data.
        contact_info:
          type: array
          items:
            type: object
            $ref: '#/components/schemas/v3ContactInfo'
          description: 'Contact information for this client. Typically used to indicate who to contact with technical/security questions about the application.

            This information is public and can be seen by any authenticated user in the network.

            This field is deprecated. Use administrative_contact and technical_contact instead.'
        administrative_contact:
          $ref: '#/components/schemas/v3OrganizationOrUserIdentifiers'
        technical_contact:
          $ref: '#/components/schemas/v3OrganizationOrUserIdentifiers'
        secret:
          type: string
          description: The client secret is only visible to collaborators of the client.
        redirect_uris:
          type: array
          items:
            type: string
          description: 'The allowed redirect URIs against which authorization requests are checked.

            If the authorization request does not pass a redirect URI, the first one

            from this list is taken.

            This information is public and can be seen by any authenticated user in the network.'
        logout_redirect_uris:
          type: array
          items:
            type: string
          description: 'The allowed logout redirect URIs against which client initiated logout

            requests are checked. If the authorization request does not pass a redirect

            URI, the first one from this list is taken.

            This information is public and can be seen by any authenticated user in the network.'
        state:
          $ref: '#/components/schemas/v3State'
          description: 'The reviewing state of the client.

            This information is public and can be seen by any authenticated user in the network.

            This field can only be modified by admins.

            If state_description is not updated when updating state, state_description is cleared.'
        state_description:
          type: string
          description: 'A description for the state field.

            This field can only be modified by admins, and should typically only be updated

            when also updating `state`.'
        skip_authorization:
          type: boolean
          description: 'If set, the authorization page will be skipped.

            This information is public and can be seen by any authenticated user in the network.

            This f

# --- truncated at 32 KB (74 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/the-things-network/refs/heads/main/openapi/the-things-network-entityregistrysearch-api-openapi.yml