The Things Network / The Things Stack OrganizationRegistry 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 OrganizationRegistry. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 9 JSON Schemas.
This API exposes
8 operations
across 7 paths,
and defines 12 schemas.
It is described by OpenAPI 2.0, at version v3.36.
8 operations7 paths12 schemas2 DELETE3 GET2 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
The Things Network / The Things Stack OrganizationRegistry 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 8
Across 7 paths, the API surfaces 8 operations — 2 DELETE, 3 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
OrganizationRegistry 8
GET
/organizations
List organizations where the given user or organization is a direct collaborator. If no user or organization is given, this returns the organizations the caller has access to. Similar to Get, this se…
OrganizationRegistry_List8 params→ 200default
PUT
/organizations/{organization.ids.organization_id}
Update the organization, changing the fields specified by the field mask to the provided values.
OrganizationRegistry_Update2 params→ 200default
GET
/organizations/{organization_ids.organization_id}
Get the organization 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.
OrganizationRegistry_Get2 params→ 200default
DELETE
/organizations/{organization_id}
Delete the organization. This may not release the organization ID for reuse.
OrganizationRegistry_Delete1 param→ 200default
DELETE
/organizations/{organization_id}/purge
Purge the organization. This will release the organization ID for reuse. The user is responsible for clearing data from any (external) integrations that may store and expose data by user or organizat…
List organizations where the given user or organization is a direct collaborator. If no user or organization is given, this returns the organizations the caller has access to. Similar to Get, this se…
Create a new organization. This also sets the given user as first collaborator with all possible rights.
OrganizationRegistry_Create2 params→ 200default
Schemas 12
The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are v3Organization (11 properties), v3ContactInfo (5 properties), googlerpcStatus (3 properties), v3OrganizationRegistryCreateBody (2 properties). Each schema is shown below with its type and property counts.
v3Organization
object
11 properties
googlerpcStatus
object
3 properties
v3ContactMethod
string
v3OrganizationOrUserIdentifiers
object
OrganizationOrUserIdentifiers contains either organization or user identifiers.
2 properties
v3ContactType
string
v3Organizations
object
1 property
v3OrganizationRegistryUpdateBody
object
2 properties
v3UserIdentifiers
object
2 properties
v3ContactInfo
object
5 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
v3OrganizationRegistryCreateBody
object
2 properties
v3OrganizationIdentifiers
object
1 property
Specification
The full machine-readable OpenAPI contract behind this narrative.
