The Things Network / The Things Stack UserAccess 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 UserAccess. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 9 JSON Schemas.
This API exposes
7 operations
across 5 paths,
and defines 9 schemas.
It is described by OpenAPI 2.0, at version v3.36.
7 operations5 paths9 schemas1 DELETE3 GET2 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
The Things Network / The Things Stack UserAccess 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 7
Across 5 paths, the API surfaces 7 operations — 1 DELETE, 3 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
UserAccess 7
GET
/users/{user_ids.user_id}/api-keys
List the API keys for this user.
UserAccess_ListAPIKeys5 params→ 200default
POST
/users/{user_ids.user_id}/api-keys
Create an API key scoped to this user. User API keys can give access to the user itself, as well as any organization, application, gateway and OAuth client this user is a collaborator of.
UserAccess_CreateAPIKey2 params→ 200default
PUT
/users/{user_ids.user_id}/api-keys/{api_key.id}
Update the rights of an API key of the user. This method can also be used to delete the API key, by giving it no rights. The caller is required to have all assigned or/and removed rights.
UserAccess_UpdateAPIKey3 params→ 200default
GET
/users/{user_ids.user_id}/api-keys/{key_id}
Get a single API key of this user.
UserAccess_GetAPIKey3 params→ 200default
DELETE
/users/{user_ids.user_id}/api-keys/{key_id}
Delete a single API key of this user.
UserAccess_DeleteAPIKey3 params→ 200default
POST
/users/{user_ids.user_id}/login-tokens
Create a login token that can be used for a one-time login as a user.
UserAccess_CreateLoginToken3 params→ 200default
GET
/users/{user_id}/rights
List the rights the caller has on this user.
UserAccess_ListRights2 params→ 200default
Schemas 9
The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are v3APIKey (7 properties), v3UserAccessCreateAPIKeyBody (4 properties), v3UserAccessUpdateAPIKeyBody (3 properties), googlerpcStatus (3 properties). Each schema is shown below with its type and property counts.
v3Rights
object
1 property
v3APIKey
object
7 properties
googlerpcStatus
object
3 properties
v3UserAccessUpdateAPIKeyBody
object
3 properties
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…
v3CreateLoginTokenResponse
object
1 property
v3UserAccessCreateAPIKeyBody
object
4 properties
v3APIKeys
object
1 property
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
Specification
The full machine-readable OpenAPI contract behind this narrative.
