How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

The Things Network / The Things Stack UserRegistry API

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

The Things Network / The Things Stack UserRegistry API is one of 58 APIs that The Things Network / The Things Stack publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 9 JSON Schema definitions.

Tagged areas include UserRegistry. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 9 JSON Schemas.

This API exposes 9 operations across 8 paths, and defines 24 schemas. It is described by OpenAPI 3.2.0, at version v3.36.

Requests are made against a single base URL, https://eu1.cloud.thethings.industries/api/v3.

9 operations 8 paths 24 schemas 2 DELETE2 GET3 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v3.36
Base URL
https://eu1.cloud.thethings.network/api/v3
Authentication
API Key
License
Resource Areas
1

Authentication & Security 1

The Things Network / The Things Stack UserRegistry API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (ApiKeyAuth). By default, every request must be authenticated.

  • ApiKeyAuth — Bearer API key. Set Authorization: Bearer NNSXS.xxxxxxxxxx.

Paths & Operations 9

Across 8 paths, the API surfaces 9 operations — 2 DELETE, 2 GET, 3 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

UserRegistry 9
GET
/users
List users of the network. This method is typically restricted to admins only.
UserRegistry_List 5 params → 200default
POST
/users
Register a new user. This method may be restricted by network settings.
UserRegistry_Create body → 200default
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.
UserRegistry_Update 1 param body → 200default
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.
UserRegistry_Get 3 params → 200default
PUT
/users/{user_ids.user_id}/password
Update the password of the user.
UserRegistry_UpdatePassword 1 param body → 200default
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.
UserRegistry_CreateTemporaryPassword 2 params → 200default
DELETE
/users/{user_id}
Delete the user. This may not release the user ID for reuse.
UserRegistry_Delete 2 params → 200default
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 organization ID.
UserRegistry_Purge 2 params → 200default
POST
/users/{user_id}/restore
Restore a recently deleted user.
UserRegistry_Restore 2 params → 200default

Schemas 24

The contract defines 24 schemas that model the data the API accepts and returns. The most detailed are v3User (23 properties), UserConsolePreferencesDashboardLayouts (8 properties), UserConsolePreferencesSortBy (7 properties), v3ContactInfo (5 properties). Each schema is shown below with its type and property counts.

v3UserRegistryUpdateBody
object
2 properties
UserConsolePreferencesDashboardLayouts
object
8 properties
PictureEmbedded
object
2 properties
UserConsolePreferencesSortBy
object
SortBy defines the field to which the Console will sort the display of entities.
7 properties
v3Picture
object
2 properties
v3ContactType
string
googlerpcStatus
object
3 properties
v3CreateUserRequest
object
2 properties
v3ConsoleTheme
string
ConsoleTheme is the theme of the Console. - CONSOLETHEMESYSTEM: The user prefers the system mode. - CONSOLETHEMELIGHT: The user prefers the light mode. - CONSO…
v3User
object
User is the message that defines a user on the network.
23 properties
UserConsolePreferencesTutorials
object
1 property
v3DashboardLayout
string
DashboardLayout is a set of possible layout values to be used in the Console.
UserRegistryUpdatePasswordBody
object
4 properties
v3UserIdentifiers
object
2 properties
v3ContactInfo
object
5 properties
v3ContactMethod
string
protobufAny
object
Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. Protobuf library provides supp…
1 property
v3NotificationType
string
v3State
string
State enum defines states that an entity can be in. - STATEREQUESTED: Denotes that the entity has been requested and is pending review by an admin. - STATEAPPR…
v3EmailNotificationPreferences
object
EmailNotificationPreferences is the message that defines the types of notifications for which the user wants to receive an email.
1 property
v3Users
object
1 property
v3UserConsolePreferences
object
UserConsolePreferences is the message that defines the user preferences for the Console.
4 properties
v3Tutorial
string
Tutorial is a set of possible tutorials in the Console.
v3Right
string
Right is the enum that defines all the different rights to do something in the network. - RIGHTUSERINFO: The right to view user information. - RIGHTUSERSETTING…

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

the-things-network-userregistry-api-openapi.yml Raw ↑

Other APIs The Things Network / The Things Stack publishes across the network.

The Things Network / The Things Stack AppAs API
The Things Network / The Things Stack ApplicationAccess API
The Things Network / The Things Stack ApplicationActivationSettingRegistry API
The Things Network / The Things Stack ApplicationPackageRegistry API
The Things Network / The Things Stack ApplicationPubSubRegistry API
The Things Network / The Things Stack ApplicationRegistry API
The Things Network / The Things Stack ApplicationUpStorage API
The Things Network / The Things Stack ApplicationWebhookRegistry API
The Things Network / The Things Stack As API
The Things Network / The Things Stack AsEndDeviceBatchRegistry API
The Things Network / The Things Stack AsEndDeviceRegistry API
The Things Network / The Things Stack ClientAccess API
Where this information came from

This is an independent, third-party profile of The Things Network / The Things Stack UserRegistry API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.