The Things Network / The Things Stack UserRegistry API

The UserRegistry API from The Things Network / The Things Stack — 8 operation(s) for userregistry.

Operations 9

GET /users List users of the network. This method is typically restricted to admins only. #
POST /users Register a new user. This method may be restricted by network settings. #
PUT /users/{user.ids.user_id} Update the user, changing the fields specified by the field mask to the provided values. This method can not be used to change the password, see the UpdatePassword method for that. #
GET /users/{user_ids.user_id} Get the user with the given identifiers, selecting the fields given by the field mask. The method may return more or less fields, depending on the rights of the caller. #
PUT /users/{user_ids.user_id}/password Update the password of the user. #
POST /users/{user_ids.user_id}/temporary_password Create a temporary password that can be used for updating a forgotten password. The generated password is sent to the user's email address. #
DELETE /users/{user_id} Delete the user. This may not release the user ID for reuse. #
DELETE /users/{user_id}/purge Purge the user. This will release the user ID for reuse. The user is responsible for clearing data from any (external) integrations that may store and expose data by user or organi #
POST /users/{user_id}/restore Restore a recently deleted user. #

Documentation

Specifications

Schemas & Data

Other Resources

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/the-things-network-userregistry-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

the-things-network-userregistry-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Things Stack — Application Server AppAs User Registry 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: UserRegistry
paths:
  /users:
    get:
      summary: List users of the network. This method is typically restricted to admins only.
      operationId: UserRegistry_List
      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: field_mask
        description: The names of the user fields that should be returned.
        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:
      - UserRegistry
    post:
      summary: Register a new user. This method may be restricted by network settings.
      operationId: UserRegistry_Create
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v3User'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/googlerpcStatus'
      tags:
      - UserRegistry
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/v3CreateUserRequest'
        required: true
  /users/{user.ids.user_id}:
    put:
      summary: 'Update the user, changing the fields specified by the field mask to the provided values.

        This method can not be used to change the password, see the UpdatePassword method for that.'
      operationId: UserRegistry_Update
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v3User'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/googlerpcStatus'
      parameters:
      - name: user.ids.user_id
        description: This ID shares namespace with organization IDs.
        in: path
        required: true
        schema:
          type: string
      tags:
      - UserRegistry
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/v3UserRegistryUpdateBody'
        required: true
  /users/{user_ids.user_id}:
    get:
      summary: 'Get the user with the given identifiers, selecting the fields given by the

        field mask. The method may return more or less fields, depending on the rights

        of the caller.'
      operationId: UserRegistry_Get
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v3User'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/googlerpcStatus'
      parameters:
      - name: user_ids.user_id
        description: This ID shares namespace with organization IDs.
        in: path
        required: true
        schema:
          type: string
      - name: user_ids.email
        description: Secondary identifier, which can only be used in specific requests.
        in: query
        required: false
        schema:
          type: string
      - name: field_mask
        description: The names of the user fields that should be returned.
        in: query
        required: false
        schema:
          type: string
      tags:
      - UserRegistry
  /users/{user_ids.user_id}/password:
    put:
      summary: Update the password of the user.
      operationId: UserRegistry_UpdatePassword
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                type: object
                properties: {}
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/googlerpcStatus'
      parameters:
      - name: user_ids.user_id
        description: This ID shares namespace with organization IDs.
        in: path
        required: true
        schema:
          type: string
      tags:
      - UserRegistry
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserRegistryUpdatePasswordBody'
        required: true
  /users/{user_ids.user_id}/temporary_password:
    post:
      summary: 'Create a temporary password that can be used for updating a forgotten password.

        The generated password is sent to the user''s email address.'
      operationId: UserRegistry_CreateTemporaryPassword
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                type: object
                properties: {}
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/googlerpcStatus'
      parameters:
      - name: user_ids.user_id
        description: This ID shares namespace with organization IDs.
        in: path
        required: true
        schema:
          type: string
      - name: user_ids.email
        description: Secondary identifier, which can only be used in specific requests.
        in: query
        required: false
        schema:
          type: string
      tags:
      - UserRegistry
  /users/{user_id}:
    delete:
      summary: Delete the user. This may not release the user ID for reuse.
      operationId: UserRegistry_Delete
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                type: object
                properties: {}
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/googlerpcStatus'
      parameters:
      - name: user_id
        description: This ID shares namespace with organization IDs.
        in: path
        required: true
        schema:
          type: string
      - name: email
        description: Secondary identifier, which can only be used in specific requests.
        in: query
        required: false
        schema:
          type: string
      tags:
      - UserRegistry
  /users/{user_id}/purge:
    delete:
      summary: 'Purge the user. This will release the user 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: UserRegistry_Purge
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                type: object
                properties: {}
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/googlerpcStatus'
      parameters:
      - name: user_id
        description: This ID shares namespace with organization IDs.
        in: path
        required: true
        schema:
          type: string
      - name: email
        description: Secondary identifier, which can only be used in specific requests.
        in: query
        required: false
        schema:
          type: string
      tags:
      - UserRegistry
  /users/{user_id}/restore:
    post:
      summary: Restore a recently deleted user.
      description: 'Deployment configuration may specify if, and for how long after deletion,

        entities can be restored.'
      operationId: UserRegistry_Restore
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                type: object
                properties: {}
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/googlerpcStatus'
      parameters:
      - name: user_id
        description: This ID shares namespace with organization IDs.
        in: path
        required: true
        schema:
          type: string
      - name: email
        description: Secondary identifier, which can only be used in specific requests.
        in: query
        required: false
        schema:
          type: string
      tags:
      - UserRegistry
components:
  schemas:
    v3UserRegistryUpdateBody:
      type: object
      properties:
        user:
          type: object
          properties:
            ids:
              type: object
              properties:
                email:
                  type: string
                  description: Secondary identifier, which can only be used in specific requests.
              description: The identifiers of the user. These are public and can be seen by any authenticated user in the network.
              title: The identifiers of the user. These are public and can be seen by any authenticated user in the network.
            created_at:
              type: string
              format: date-time
              description: When the user 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 user 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 user 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 user. This information is public and can be seen by any authenticated user in the network.
            description:
              type: string
              description: A description for the user. 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 users. Typically used for storing integration-specific data.
            contact_info:
              type: array
              items:
                type: object
                $ref: '#/components/schemas/v3ContactInfo'
              description: 'Contact information for this user. Typically used to indicate who to contact with security/billing questions about the user.

                This field is deprecated.'
            primary_email_address:
              type: string
              description: 'Primary email address that can be used for logging in.

                This address is not public, use contact_info for that.'
            primary_email_address_validated_at:
              type: string
              format: date-time
              description: When the primary email address was validated. Note that email address validation is not required on all networks.
            password:
              type: string
              description: 'The password field is only considered when creating a user.

                It is not returned on API calls, and can not be updated by updating the User.

                See the UpdatePassword method of the UserRegistry service for more information.'
            password_updated_at:
              type: string
              format: date-time
            require_password_update:
              type: boolean
            state:
              $ref: '#/components/schemas/v3State'
              description: 'The reviewing state of the user.

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

                This field can only be modified by admins.'
            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`.'
            admin:
              type: boolean
              description: 'This user is an admin.

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

                This field can only be modified by other admins.'
            temporary_password:
              type: string
              description: 'The temporary password can only be used to update a user''s password; never returned on API calls.

                It is not returned on API calls, and can not be updated by updating the User.

                See the CreateTemporaryPassword method of the UserRegistry service for more information.'
            temporary_password_created_at:
              type: string
              format: date-time
            temporary_password_expires_at:
              type: string
              format: date-time
            profile_picture:
              $ref: '#/components/schemas/v3Picture'
              description: 'A profile picture for the user.

                This information is public and can be seen by any authenticated user in the network.'
            console_preferences:
              $ref: '#/components/schemas/v3UserConsolePreferences'
              description: Console preferences contains the user's preferences regarding the behavior of the Console.
            email_notification_preferences:
              $ref: '#/components/schemas/v3EmailNotificationPreferences'
            universal_rights:
              type: array
              items:
                $ref: '#/components/schemas/v3Right'
              description: Universal rights are capable of restricting the user's interactions with the API, be it an admin or not.
          description: User is the message that defines a user on the network.
        field_mask:
          type: string
          description: The names of the user fields that should be updated.
    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'
    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.
    v3Picture:
      type: object
      properties:
        embedded:
          $ref: '#/components/schemas/PictureEmbedded'
          description: 'Embedded picture.

            Omitted if there are external URLs available (in sizes).'
        sizes:
          type: object
          additionalProperties:
            type: string
          description: URLs of the picture for different sizes, if available on a CDN.
    v3ContactType:
      type: string
      enum:
      - CONTACT_TYPE_OTHER
      - CONTACT_TYPE_ABUSE
      - CONTACT_TYPE_BILLING
      - CONTACT_TYPE_TECHNICAL
      default: CONTACT_TYPE_OTHER
    googlerpcStatus:
      type: object
      properties:
        code:
          type: integer
          format: int32
        message:
          type: string
        details:
          type: array
          items:
            type: object
            $ref: '#/components/schemas/protobufAny'
    v3CreateUserRequest:
      type: object
      properties:
        user:
          $ref: '#/components/schemas/v3User'
        invitation_token:
          type: string
          description: The invitation token that was sent to the user (some networks require an invitation in order to register new users).
    v3ConsoleTheme:
      type: string
      enum:
      - CONSOLE_THEME_SYSTEM
      - CONSOLE_THEME_LIGHT
      - CONSOLE_THEME_DARK
      default: CONSOLE_THEME_SYSTEM
      description: "ConsoleTheme is the theme of the Console.\n\n - CONSOLE_THEME_SYSTEM: The user prefers the system mode.\n - CONSOLE_THEME_LIGHT: The user prefers the light mode.\n - CONSOLE_THEME_DARK: The user prefers the dark mode."
    v3User:
      type: object
      properties:
        ids:
          $ref: '#/components/schemas/v3UserIdentifiers'
          description: The identifiers of the user. These are public and can be seen by any authenticated user in the network.
        created_at:
          type: string
          format: date-time
          description: When the user 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 user 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 user 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 user. This information is public and can be seen by any authenticated user in the network.
        description:
          type: string
          description: A description for the user. 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 users. Typically used for storing integration-specific data.
        contact_info:
          type: array
          items:
            type: object
            $ref: '#/components/schemas/v3ContactInfo'
          description: 'Contact information for this user. Typically used to indicate who to contact with security/billing questions about the user.

            This field is deprecated.'
        primary_email_address:
          type: string
          description: 'Primary email address that can be used for logging in.

            This address is not public, use contact_info for that.'
        primary_email_address_validated_at:
          type: string
          format: date-time
          description: When the primary email address was validated. Note that email address validation is not required on all networks.
        password:
          type: string
          description: 'The password field is only considered when creating a user.

            It is not returned on API calls, and can not be updated by updating the User.

            See the UpdatePassword method of the UserRegistry service for more information.'
        password_updated_at:
          type: string
          format: date-time
        require_password_update:
          type: boolean
        state:
          $ref: '#/components/schemas/v3State'
          description: 'The reviewing state of the user.

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

            This field can only be modified by admins.'
        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`.'
        admin:
          type: boolean
          description: 'This user is an admin.

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

            This field can only be modified by other admins.'
        temporary_password:
          type: string
          description: 'The temporary password can only be used to update a user''s password; never returned on API calls.

            It is not returned on API calls, and can not be updated by updating the User.

            See the CreateTemporaryPassword method of the UserRegistry service for more information.'
        temporary_password_created_at:
          type: string
          format: date-time
        temporary_password_expires_at:
          type: string
          format: date-time
        profile_picture:
          $ref: '#/components/schemas/v3Picture'
          description: 'A profile picture for the user.

            This information is public and can be seen by any authenticated user in the network.'
        console_preferences:
          $ref: '#/components/schemas/v3UserConsolePreferences'
          description: Console preferences contains the user's preferences regarding the behavior of the Console.
        email_notification_preferences:
          $ref: '#/components/schemas/v3EmailNotificationPreferences'
        universal_rights:
          type: array
          items:
            $ref: '#/components/schemas/v3Right'
          description: Universal rights are capable of restricting the user's interactions with the API, be it an admin or not.
      description: User is the message that defines a user on the network.
    UserConsolePreferencesTutorials:
      type: object
      properties:
        seen:
          type: array
          items:
            $ref: '#/components/schemas/v3Tutorial'
    v3DashboardLayout:
      type: string
      enum:
      - DASHBOARD_LAYOUT_TABLE
      - DASHBOARD_LAYOUT_LIST
      - DASHBOARD_LAYOUT_GRID
      default: DASHBOARD_LAYOUT_TABLE
      description: DashboardLayout is a set of possible layout values to be used in the Console.
    UserRegistryUpdatePasswordBody:
      type: object
      properties:
        user_ids:
          type: object
          properties:
            email:
              type: string
              description: Secondary identifier, which can only be used in specific requests.
        new:
          type: string
        old:
          type: string
        revoke_all_access:
          type: boolean
          description: Revoke active sessions and access tokens of user if true. To be used if credentials are suspected to be compromised.
    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: '#/components/schemas/v3ContactType'
        contact_method:
          $ref: '#/components/schemas/v3ContactMethod'
        value:
          type: string
        public:
          type: boolean
        validated_at:
          type: string
          format: date-time
    v3ContactMethod:
      type: string
      enum:
      - CONTACT_METHOD_OTHER
      - CONTACT_METHOD_EMAIL
      - CONTACT_METHOD_PHONE
      default: CONTACT_METHOD_OTHER
    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    }"
    v3NotificationType:
      type: string
      enum:
      - UNKNOWN
      - API_KEY_CREATED
      - API_KEY_CHANGED
      - CLIENT_REQUESTED
      - COLLABORATOR_CHANGED
      - ENTITY_STATE_CHANGED
      - INVITATION
      - LOGIN_TOKEN
      - PASSWORD_CHANGED
      - TEMPORARY_PASSWORD
      - USER_REQUESTED
      - VALIDATE
      default: UNKNOWN
    v3State:
      type: string
      enum:
      - STATE_REQUESTED
      - STATE_APPROVED
      - STATE_REJECTED
      - STATE_FLAGGED
      - STATE_SUSPENDED
      default: STATE_REQUESTED
      description: "State enum defines states that an entity can be in.\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."
    v3EmailNotificationPreferences:
      type: object
      properties:
        types:
          type: array
          items:
            $ref: '#/components/schemas/v3NotificationType'
      description: EmailNotificationPreferences is the message that defines the types of notifications for which the user wants to receive an email.
    v3Users:
      type: object
      properties:
        users:
          type: array
          items:
            type: object
            $ref: '#/components/schemas/v3User'
    v3UserConsolePreferences:
      type: object
      properties:
        console_theme:
          $ref: '#/components/schemas/v3ConsoleTheme'
        dashboard_layouts:
          $ref: '#/components/schemas/UserConsolePreferencesDashboardLayouts'
        sort_by:
          $ref: '#/components/schemas/UserConsolePreferencesSortBy'
        tutorials:
          $ref: '#/components/schemas/UserConsolePreferencesTutorials'
      description: UserConsolePreferences is the message that defines the user preferences for the Console.
    v3Tutorial:
      type: string
      enum:
      - TUTORIAL_UNKNOWN
      - TUTORIAL_LIVE_DATA_SPLIT_VIEW
      default: TUTORIAL_UNKNOWN
      description: Tutorial is a set of possible tutorials in the Console.
    v3Right:
      type: string
      enum:
      - right_invalid
      - RIGHT_USER_INFO
      - RIGHT_USER_SETTINGS_BASIC
      - RIGHT_USER_LIST
      - RIGHT_USER_CREATE
      - RIGHT_USER_SETTINGS_API_KEYS
      - RIGHT_USER_DELETE
      - RIGHT_USER_PURGE
      - RIGHT_USER_AUTHORIZED_CLIENTS
      - RIGHT_USER_APPLICATIONS_LIST
      - RIGHT_USER_APPLICATIONS_CREATE
      - RIGHT_USER_GATEWAYS_LIST
      

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