The Things Network / The Things Stack Is API

swagger: '2.0'
info:
  title: The Things Stack — Application Server AppAs Is 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: Is
paths:
  /is/configuration:
    get:
      summary: 'Get the configuration of the Identity Server. The response is typically used

        to enable or disable features in a user interface.'
      operationId: Is_GetConfiguration
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/v3GetIsConfigurationResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/googlerpcStatus'
      tags:
      - Is
definitions:
  IsConfigurationUserRegistration:
    type: object
    properties:
      invitation:
        $ref: '#/definitions/IsConfigurationUserRegistrationInvitation'
      contact_info_validation:
        $ref: '#/definitions/IsConfigurationUserRegistrationContactInfoValidation'
      admin_approval:
        $ref: '#/definitions/UserRegistrationAdminApproval'
      password_requirements:
        $ref: '#/definitions/UserRegistrationPasswordRequirements'
      enabled:
        type: boolean
  IsConfigurationProfilePicture:
    type: object
    properties:
      disable_upload:
        type: boolean
      use_gravatar:
        type: boolean
  IsConfigurationEndDevicePicture:
    type: object
    properties:
      disable_upload:
        type: boolean
  UserRegistrationAdminApproval:
    type: object
    properties:
      required:
        type: boolean
  IsConfigurationUserLogin:
    type: object
    properties:
      disable_credentials_login:
        type: boolean
  googlerpcStatus:
    type: object
    properties:
      code:
        type: integer
        format: int32
      message:
        type: string
      details:
        type: array
        items:
          type: object
          $ref: '#/definitions/protobufAny'
  UserRegistrationPasswordRequirements:
    type: object
    properties:
      min_length:
        type: integer
        format: int64
      max_length:
        type: integer
        format: int64
      min_uppercase:
        type: integer
        format: int64
      min_digits:
        type: integer
        format: int64
      min_special:
        type: integer
        format: int64
  IsConfigurationAdminRights:
    type: object
    properties:
      all:
        type: boolean
  v3IsConfiguration:
    type: object
    properties:
      user_registration:
        $ref: '#/definitions/IsConfigurationUserRegistration'
      profile_picture:
        $ref: '#/definitions/IsConfigurationProfilePicture'
      end_device_picture:
        $ref: '#/definitions/IsConfigurationEndDevicePicture'
      user_rights:
        $ref: '#/definitions/IsConfigurationUserRights'
      user_login:
        $ref: '#/definitions/IsConfigurationUserLogin'
      admin_rights:
        $ref: '#/definitions/IsConfigurationAdminRights'
      collaborator_rights:
        $ref: '#/definitions/IsConfigurationCollaboratorRights'
  IsConfigurationUserRegistrationContactInfoValidation:
    type: object
    properties:
      required:
        type: boolean
      token_ttl:
        type: string
      retry_interval:
        type: string
        description: The minimum interval between validation emails.
  IsConfigurationUserRegistrationInvitation:
    type: object
    properties:
      required:
        type: boolean
      token_ttl:
        type: string
  v3GetIsConfigurationResponse:
    type: object
    properties:
      configuration:
        $ref: '#/definitions/v3IsConfiguration'
  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\": <string>,\n      \"lastName\": <string>\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    }"
  IsConfigurationUserRights:
    type: object
    properties:
      create_applications:
        type: boolean
      create_clients:
        type: boolean
      create_gateways:
        type: boolean
      create_organizations:
        type: boolean
  IsConfigurationCollaboratorRights:
    type: object
    properties:
      set_others_as_contacts:
        type: boolean
securityDefinitions:
  ApiKeyAuth:
    type: apiKey
    in: header
    name: Authorization
    description: 'Bearer API key. Set Authorization: Bearer NNSXS.xxxxxxxxxx.'