Tenant APIs

Authentication

Unlike the other services, the tenant services do not accept API keys or OAuth access tokens. Instead, authentication is done with a “tenant admin key” that is configured in the Identity Server

  • Usage with HTTP Authorization Header: TenantAdminKey XXXXX
  • Usage with gRPC call credentials (in the authorization header): TenantAdminKey XXXXX

The TenantRegistry service

Method TenantRegistry.Create
Request type CreateTenantRequest
Response type Tenant
HTTP bindings

POST /api/v3/tenants
Method TenantRegistry.Get
Request type GetTenantRequest
Response type Tenant
HTTP bindings

GET /api/v3/tenants/{tenant_ids.tenant_id}
Method TenantRegistry.GetRegistryTotals
Request type GetTenantRegistryTotalsRequest
Response type TenantRegistryTotals
HTTP bindings

GET /api/v3/tenants/{tenant_ids.tenant_id}/registry-totals
Method TenantRegistry.List
Request type ListTenantsRequest
Response type Tenants
HTTP bindings

GET /api/v3/tenants
Method TenantRegistry.Update
Request type UpdateTenantRequest
Response type Tenant
HTTP bindings

PUT /api/v3/tenants/{tenant.ids.tenant_id}
Method TenantRegistry.Delete
Request type TenantIdentifiers
Response type google.protobuf.Empty
HTTP bindings

DELETE /api/v3/tenants/{tenant_id}

Messages

Message Tenant

Tenant is the message that defines a Tenant in the network.

Show object example 
{
  "ids": {},
  "created_at": "0001-01-01T00:00:00Z",
  "updated_at": "0001-01-01T00:00:00Z",
  "name": "",
  "description": "",
  "attributes": {},
  "contact_info": [],
  "max_applications": null,
  "max_clients": null,
  "max_end_devices": null,
  "max_gateways": null,
  "max_organizations": null,
  "max_users": null,
  "state": "STATE_REQUESTED",
  "state_description": "",
  "capabilities": {},
  "configuration": {},
  "billing": {},
  "billing_identifiers": {},
}

Fields:

Field ids
Type TenantIdentifiers
Description

required
Field created_at
Type google.protobuf.Timestamp
Field updated_at
Type google.protobuf.Timestamp
Field name
Type string
Description

max_len: 50
Field description
Type string
Description

max_len: 2000
Field attributes
Type map of string to string
Field contact_info
Type repeated ttn.lorawan.v3.ContactInfo
Description
Field max_applications
Type google.protobuf.UInt64Value
Description

If set, restricts the maximum number of applications that can be created.
Field max_clients
Type google.protobuf.UInt64Value
Description

If set, restricts the maximum number of clients that can be created.
Field max_end_devices
Type google.protobuf.UInt64Value
Description

If set, restricts the maximum number of end_devices that can be created.
Field max_gateways
Type google.protobuf.UInt64Value
Description

If set, restricts the maximum number of gateways that can be created.
Field max_organizations
Type google.protobuf.UInt64Value
Description

If set, restricts the maximum number of organizations that can be created.
Field max_users
Type google.protobuf.UInt64Value
Description

If set, restricts the maximum number of users that can be created.
Field state
Type ttn.lorawan.v3.State
Description

The reviewing state of the tenant. This field can only be modified by tenant admins. If state_description is not updated when updating state, state_description is cleared.

defined_only
Field state_description
Type string
Description

A description for the state field. This field can only be modified by admins, and should typically only be updated when also updating state.

max_len: 128
Field capabilities
Type google.protobuf.Struct
Field configuration
Type Configuration
Field billing
Type Billing
Field billing_identifiers
Type BillingIdentifiers

Message TenantIdentifiers

Show object example 
{
  "tenant_id": "",
}

Fields:

Field tenant_id
Type string
Description

max_len: 36

pattern: ^[a-z0-9](?:[-]?[a-z0-9]){2,}$

Message Tenants

Show object example 
{
  "tenants": [],
}

Fields:

Field tenants
Type repeated Tenant
Description

Message CreateTenantRequest

Show object example 
{
  "tenant": {},
  "initial_user": {},
}

Fields:

Field tenant
Type Tenant
Description

required
Field initial_user
Type ttn.lorawan.v3.User

Message GetTenantRequest

Show object example 
{
  "tenant_ids": {},
  "field_mask": {},
}

Fields:

Field tenant_ids
Type TenantIdentifiers
Description

required
Field field_mask
Type google.protobuf.FieldMask

Message GetTenantRegistryTotalsRequest

Show object example 
{
  "tenant_ids": {},
  "field_mask": {},
}

Fields:

Field tenant_ids
Type TenantIdentifiers
Field field_mask
Type google.protobuf.FieldMask

Message TenantRegistryTotals

Show object example 
{
  "applications": 0,
  "clients": 0,
  "end_devices": 0,
  "gateways": 0,
  "organizations": 0,
  "users": 0,
}

Fields:

Field applications
Type uint64
Field clients
Type uint64
Field end_devices
Type uint64
Field gateways
Type uint64
Field organizations
Type uint64
Field users
Type uint64

Message ListTenantsRequest

Show object example 
{
  "field_mask": {},
  "order": "",
  "limit": 0,
  "page": 0,
}

Fields:

Field field_mask
Type google.protobuf.FieldMask
Field order
Type string
Description

Order the results by this field path (must be present in the field mask). Default ordering is by ID. Prepend with a minus (-) to reverse the order.

in: [ tenant_id -tenant_id name -name created_at -created_at]
Field limit
Type uint32
Description

Limit the number of results per page.

lte: 1000
Field page
Type uint32
Description

Page number for pagination. 0 is interpreted as 1.

Message UpdateTenantRequest

Show object example 
{
  "tenant": {},
  "field_mask": {},
}

Fields:

Field tenant
Type Tenant
Description

required
Field field_mask
Type google.protobuf.FieldMask
← Storage Integration API User APIs →