Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

The Things Network / The Things Stack ClientAccess API

The ClientAccess API from The Things Network / The Things Stack — 6 operation(s) for clientaccess.

The Things Network / The Things Stack ClientAccess 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 ClientAccess. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 9 JSON Schemas.

This API exposes 7 operations across 6 paths, and defines 11 schemas. It is described by OpenAPI 2.0, at version v3.36.

7 operations 6 paths 11 schemas 2 DELETE4 GET1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
v3.36
Authentication
API Key
License
Resource Areas
1

Authentication & Security 1

The Things Network / The Things Stack ClientAccess 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 6 paths, the API surfaces 7 operations — 2 DELETE, 4 GET, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

ClientAccess 7
GET
/clients/{client_ids.client_id}/collaborator/organization/{collaborator.organization_ids.organization_id}
Get the rights of a collaborator (member) of the client. Pseudo-rights in the response (such as the "ALL" right) are not expanded.
ClientAccess_GetCollaborator2 4 params → 200default
GET
/clients/{client_ids.client_id}/collaborator/user/{collaborator.user_ids.user_id}
Get the rights of a collaborator (member) of the client. Pseudo-rights in the response (such as the "ALL" right) are not expanded.
ClientAccess_GetCollaborator 4 params → 200default
GET
/clients/{client_ids.client_id}/collaborators
List the collaborators on this OAuth client.
ClientAccess_ListCollaborators 4 params → 200default
PUT
/clients/{client_ids.client_id}/collaborators
Set the rights of a collaborator (member) on the OAuth client. This method can also be used to delete the collaborator, by giving them no rights. The caller is required to have all assigned or/and re…
ClientAccess_SetCollaborator 2 params → 200default
DELETE
/clients/{client_ids.client_id}/collaborators/organization/{collaborator_ids.organization_ids.organization_id}
DeleteCollaborator removes a collaborator from a client.
ClientAccess_DeleteCollaborator2 4 params → 200default
DELETE
/clients/{client_ids.client_id}/collaborators/user/{collaborator_ids.user_ids.user_id}
DeleteCollaborator removes a collaborator from a client.
ClientAccess_DeleteCollaborator 4 params → 200default
GET
/clients/{client_id}/rights
List the rights the caller has on this application.
ClientAccess_ListRights 1 param → 200default

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are googlerpcStatus (3 properties), v3OrganizationOrUserIdentifiers (2 properties), v3GetCollaboratorResponse (2 properties), v3ClientAccessSetCollaboratorBody (2 properties). Each schema is shown below with its type and property counts.

v3ClientAccessSetCollaboratorBody
object
2 properties
v3Rights
object
1 property
v3Collaborator
object
2 properties
googlerpcStatus
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…
v3UserIdentifiers
object
2 properties
v3Collaborators
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
v3GetCollaboratorResponse
object
2 properties
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.

Source

the-things-network-clientaccess-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 ClientRegistry API