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 2.0, at version v3.36.
9 operations8 paths24 schemas2 DELETE2 GET3 POST2 PUT
Metadata
The identity and technical contract details declared by the specification.
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_List5 params→ 200default
POST
/users
Register a new user. This method may be restricted by network settings.
UserRegistry_Create1 param→ 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_Update2 params→ 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_Get3 params→ 200default
PUT
/users/{user_ids.user_id}/password
Update the password of the user.
UserRegistry_UpdatePassword2 params→ 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.
Delete the user. This may not release the user ID for reuse.
UserRegistry_Delete2 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_Purge2 params→ 200default
POST
/users/{user_id}/restore
Restore a recently deleted user.
UserRegistry_Restore2 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.
UserConsolePreferencesSortBy
object
SortBy defines the field to which the Console will sort the display of entities.
7 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
PictureEmbedded
object
2 properties
v3ContactMethod
string
v3ContactType
string
v3EmailNotificationPreferences
object
EmailNotificationPreferences is the message that defines the types of notifications for which the user wants to receive an email.
1 property
v3UserRegistryUpdateBody
object
2 properties
UserConsolePreferencesDashboardLayouts
object
8 properties
UserConsolePreferencesTutorials
object
1 property
v3UserConsolePreferences
object
UserConsolePreferences is the message that defines the user preferences for the Console.
4 properties
v3Users
object
1 property
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…
v3NotificationType
string
v3Tutorial
string
Tutorial is a set of possible tutorials in the Console.
v3DashboardLayout
string
DashboardLayout is a set of possible layout values to be used in the Console.
googlerpcStatus
object
3 properties
v3CreateUserRequest
object
2 properties
v3UserIdentifiers
object
2 properties
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…
v3ContactInfo
object
5 properties
v3Picture
object
2 properties
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
UserRegistryUpdatePasswordBody
object
4 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
