The Things Network / The Things Stack ClientRegistry 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 ClientRegistry. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 9 JSON Schemas.
This API exposes
10 operations
across 8 paths,
and defines 16 schemas.
It is described by OpenAPI 2.0, at version v3.36.
10 operations8 paths16 schemas2 DELETE4 GET3 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
The Things Network / The Things Stack ClientRegistry 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 10
Across 8 paths, the API surfaces 10 operations — 2 DELETE, 4 GET, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
ClientRegistry 10
GET
/clients
List OAuth clients where the given user or organization is a direct collaborator. If no user or organization is given, this returns the OAuth clients the caller has access to. Similar to Get, this se…
ClientRegistry_List8 params→ 200default
PUT
/clients/{client.ids.client_id}
Update the OAuth client, changing the fields specified by the field mask to the provided values.
ClientRegistry_Update2 params→ 200default
GET
/clients/{client_ids.client_id}
Get the OAuth client with the given identifiers, selecting the fields specified in the field mask. More or less fields may be returned, depending on the rights of the caller.
ClientRegistry_Get2 params→ 200default
DELETE
/clients/{client_id}
Delete the OAuth client. This may not release the client ID for reuse.
ClientRegistry_Delete1 param→ 200default
DELETE
/clients/{client_id}/purge
Purge the client. This will release the client ID for reuse.
List OAuth clients where the given user or organization is a direct collaborator. If no user or organization is given, this returns the OAuth clients the caller has access to. Similar to Get, this se…
Create a new OAuth client. This also sets the given organization or user as first collaborator with all possible rights.
ClientRegistry_Create22 params→ 200default
GET
/users/{collaborator.user_ids.user_id}/clients
List OAuth clients where the given user or organization is a direct collaborator. If no user or organization is given, this returns the OAuth clients the caller has access to. Similar to Get, this se…
ClientRegistry_List28 params→ 200default
POST
/users/{collaborator.user_ids.user_id}/clients
Create a new OAuth client. This also sets the given organization or user as first collaborator with all possible rights.
ClientRegistry_Create2 params→ 200default
Schemas 16
The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are v3Client (19 properties), v3ContactInfo (5 properties), googlerpcStatus (3 properties), v3UserIdentifiers (2 properties). Each schema is shown below with its type and property counts.
v3Clients
object
1 property
googlerpcStatus
object
3 properties
v3ClientRegistryUpdateBody
object
2 properties
v3ContactMethod
string
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…
v3ClientRegistryCreateBody
object
2 properties
v3ContactType
string
v3Client
object
An OAuth client on the network.
19 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…
v3GrantType
string
The OAuth2 flows an OAuth client can use to get an access token. - GRANTAUTHORIZATIONCODE: Grant type used to exchange an authorization code for an access toke…
v3ContactInfo
object
5 properties
v3ClientIdentifiers
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
v3OrganizationOrUserIdentifiers
object
OrganizationOrUserIdentifiers contains either organization or user identifiers.
2 properties
v3OrganizationIdentifiers
object
1 property
Specification
The full machine-readable OpenAPI contract behind this narrative.
